IRDPSRAPIViewer::DisconnectedText property

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(
  [in]  BSTR bstrDisconnectedText
);

HRESULT get_DisconnectedText(
  [out] BSTR *pbstrDisconnectedText
);

Property value

The string value that DisconnectedText is to be set to.

Error codes

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

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

See also

IRDPSRAPIViewer