IMsTscAx::ConnectingText property

Article
12/11/2020

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