IMsTscAx::put_ConnectingText
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method sets the value of the ConnectingText property, the text that appears centered in the control while the control is connecting.
Syntax
HRESULT put_ConnectingText(
BSTR connectingText
);
Parameters
- connectingText
[in] The string value the ConnectingText property is to be set to.
Return Value
The following table shows the return values for this method.
| Value | Description |
|---|---|
S_OK |
The ConnectingText property was correctly set. |
E_FAIL |
The control is already connected or in the connecting state. |
nonzero error code |
An error occurred. |
Remarks
An example of connection text is "Connecting to server...".
Setting ConnectingText 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. The method returns E_FAIL if called when 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 |