IRDPSRAPIViewer::put_DisconnectedText method (rdpencomapi.h)

[The IRDPSRAPIViewer interface is no longer available for use for UWP applications as of Windows 10, version 1709. It is still supported for Desktop apps.]

Retrieves or sets the text that appears centered in the control before a connection is terminated.

This property is read/write.

Syntax

HRESULT put_DisconnectedText(
  BSTR bstrDisconnectedText
);

Parameters

bstrDisconnectedText

Return value

None

Remarks

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

The DisconnectedText 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.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	rdpencomapi.h
DLL	RdpEncom.dll

See also

IRDPSRAPIViewer