Skip to content

Latest commit

 

History

History
157 lines (118 loc) · 5.46 KB

imstscax-disconnectedtext.md

File metadata and controls

157 lines (118 loc) · 5.46 KB
title description ms.assetid ms.tgt_platform keywords topic_type api_name api_location api_type ms.topic ms.date
IMsTscAx DisconnectedText property
Specifies the text that appears centered in the control before a connection is terminated.
ec7efe7a-8fb9-4c45-8e16-78951365de13
multiple
DisconnectedText property Remote Desktop Services
DisconnectedText property Remote Desktop Services , IMsTscAx interface
IMsTscAx interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient interface
IMsRdpClient interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient2 interface
IMsRdpClient2 interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient3 interface
IMsRdpClient3 interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient4 interface
IMsRdpClient4 interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient5 interface
IMsRdpClient5 interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient6 interface
IMsRdpClient6 interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient7 interface
IMsRdpClient7 interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient8 interface
IMsRdpClient8 interface Remote Desktop Services , DisconnectedText property
DisconnectedText property Remote Desktop Services , IMsRdpClient9 interface
IMsRdpClient9 interface Remote Desktop Services , DisconnectedText property
apiref
IMsTscAx.DisconnectedText
IMsTscAx.get_DisconnectedText
IMsTscAx.put_DisconnectedText
IMsRdpClient.DisconnectedText
IMsRdpClient.get_DisconnectedText
IMsRdpClient.put_DisconnectedText
IMsRdpClient2.DisconnectedText
IMsRdpClient2.get_DisconnectedText
IMsRdpClient2.put_DisconnectedText
IMsRdpClient3.DisconnectedText
IMsRdpClient3.get_DisconnectedText
IMsRdpClient3.put_DisconnectedText
IMsRdpClient4.DisconnectedText
IMsRdpClient4.get_DisconnectedText
IMsRdpClient4.put_DisconnectedText
IMsRdpClient5.DisconnectedText
IMsRdpClient5.get_DisconnectedText
IMsRdpClient5.put_DisconnectedText
IMsRdpClient6.DisconnectedText
IMsRdpClient6.get_DisconnectedText
IMsRdpClient6.put_DisconnectedText
IMsRdpClient7.DisconnectedText
IMsRdpClient7.get_DisconnectedText
IMsRdpClient7.put_DisconnectedText
IMsRdpClient8.DisconnectedText
IMsRdpClient8.get_DisconnectedText
IMsRdpClient8.put_DisconnectedText
IMsRdpClient9.DisconnectedText
IMsRdpClient9.get_DisconnectedText
IMsRdpClient9.put_DisconnectedText
MsTscAx.dll
COM
reference
05/31/2018

IMsTscAx::DisconnectedText property

Specifies the text that appears centered in the control before a connection is terminated.

This property is read/write.

Syntax

HRESULT put_DisconnectedText(
  [in]  BSTR newVal
);

HRESULT get_DisconnectedText(
  [out] BSTR *pDisconnectedText
);

Property value

The new display text.

Error codes

Return S_OK if successful.

Remarks

Setting the DisconnectedText property is optional. If it is not specified the control appears blank before a connection is established.

This property can be set only if the control is not in the connected state. The method returns E_FAIL if it is called after the control is connected. You can check if the control is connected by responding to connection events in IMsTscAxEvents or examining the Connected property.

This method allocates the memory required for the buffer pointed to by the pDisconnectedText parameter. Calling C/C++ applications must free the memory with a call to the SysFreeString function. This is not required for Visual Basic and scripting clients.

For more information about Remote Desktop Web Connection, see Requirements for Remote Desktop Web Connection.

Requirements

Requirement Value
Minimum supported client
Windows Vista
Minimum supported server
Windows Server 2008
Type library
MsTscAx.dll
DLL
MsTscAx.dll
IID
IID_IMsTscAx is defined as 8C11EFAE-92C3-11D1-BC1E-00C04FA31489

See also

IMsRdpClient

IMsRdpClient2

IMsRdpClient3

IMsRdpClient4

IMsRdpClient5

IMsRdpClient6

IMsRdpClient7

IMsRdpClient8

IMsRdpClient9

IMsTscAx