IMsTscAx::put_DisconnectedText (Windows Embedded CE 6.0)
1/6/2010
This method sets the value of the DisconnectedText property, the text that appears centered in the control before a connection is terminated.
Syntax
HRESULT put_DisconnectedText(
BSTR disconnectText
);
Parameters
- disconnectText
[in] The string value DisconnectedText is to be set to.
Return Value
The following table shows the return values for this method.
| Value | Description |
|---|---|
S_OK |
The DisconnectedText property was correctly set. |
E_FAIL |
The control is already connected or in the connecting state. |
nonzero error code |
An error occurred. |
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. You can check if the control is connected by calling the IMsTscAx::get_Connected method.
Requirements
| Header | discodlg.h, mstsax.idl |
| Library | Mstsax.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |