IMsRdpClient2::ConnectedStatusText property

Article
12/11/2020

Contains the text that is displayed in the client area of the control while the control is in the connected state.

This property is read/write.

Syntax

HRESULT put_ConnectedStatusText(
  [in]  BSTR newVal
);

HRESULT get_ConnectedStatusText(
  [out] BSTR *pConnectedStatusText
);

Property value

The ConnectedStatusText property contains the text that is displayed in the client area of the control while the control is in the connected state.

Error codes

Return S_OK if successful.

Remarks

Text to display in the client area of the control while the control is in the connected state. This is the text that is visible, for example, when the user switches the control to the full-screen mode in a web browser, a scenario that leaves a portion of the control hosted in the browser.

The get_ConnectedStatusText method allocates the memory required for the buffer pointed to by the pConnectedStatusText 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.

This property cannot be set when the control is connected. You can check if the control is connected by calling the IMsTscAx::get_Connected method.

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_IMsRdpClient2 is defined as e7e17dc4-3b71-4ba7-a8e6-281ffadca28f