Skip to content

Latest commit

 

History

History
161 lines (120 loc) · 5.47 KB

imstscax-connectingtext.md

File metadata and controls

161 lines (120 loc) · 5.47 KB
title description ms.assetid ms.tgt_platform keywords topic_type api_name api_location api_type ms.topic ms.date
IMsTscAx ConnectingText property
Specifies the text that appears centered in the control while the control is connecting.
9bc82074-988f-491b-80e3-00c3f7ba437a
multiple
ConnectingText property Remote Desktop Services
ConnectingText property Remote Desktop Services , IMsTscAx interface
IMsTscAx interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient interface
IMsRdpClient interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient2 interface
IMsRdpClient2 interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient3 interface
IMsRdpClient3 interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient4 interface
IMsRdpClient4 interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient5 interface
IMsRdpClient5 interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient6 interface
IMsRdpClient6 interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient7 interface
IMsRdpClient7 interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient8 interface
IMsRdpClient8 interface Remote Desktop Services , ConnectingText property
ConnectingText property Remote Desktop Services , IMsRdpClient9 interface
IMsRdpClient9 interface Remote Desktop Services , ConnectingText property
apiref
IMsTscAx.ConnectingText
IMsTscAx.get_ConnectingText
IMsTscAx.put_ConnectingText
IMsRdpClient.ConnectingText
IMsRdpClient.get_ConnectingText
IMsRdpClient.put_ConnectingText
IMsRdpClient2.ConnectingText
IMsRdpClient2.get_ConnectingText
IMsRdpClient2.put_ConnectingText
IMsRdpClient3.ConnectingText
IMsRdpClient3.get_ConnectingText
IMsRdpClient3.put_ConnectingText
IMsRdpClient4.ConnectingText
IMsRdpClient4.get_ConnectingText
IMsRdpClient4.put_ConnectingText
IMsRdpClient5.ConnectingText
IMsRdpClient5.get_ConnectingText
IMsRdpClient5.put_ConnectingText
IMsRdpClient6.ConnectingText
IMsRdpClient6.get_ConnectingText
IMsRdpClient6.put_ConnectingText
IMsRdpClient7.ConnectingText
IMsRdpClient7.get_ConnectingText
IMsRdpClient7.put_ConnectingText
IMsRdpClient8.ConnectingText
IMsRdpClient8.get_ConnectingText
IMsRdpClient8.put_ConnectingText
IMsRdpClient9.ConnectingText
IMsRdpClient9.get_ConnectingText
IMsRdpClient9.put_ConnectingText
MsTscAx.dll
COM
reference
05/31/2018

IMsTscAx::ConnectingText property

Specifies the text that appears centered in the control while the control is connecting.

This property is read/write.

Syntax

HRESULT put_ConnectingText(
  [in]  BSTR newVal
);

HRESULT get_ConnectingText(
  [out] BSTR *pConnectingText
);

Property value

The new display text.

Error codes

Return S_OK if successful.

Return a nonzero HRESULT if an error occurs.

Remarks

An example of connection text is "Connecting to server ...".

Setting the ConnectingText property is optional. If it is not set, the control appears blank before a connection is established.

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

The get_ConnectingText property method allocates the memory required for the buffer pointed to by the pConnectingText 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