Share via

IMsTscAx::put_DisconnectedText

  • Article

This method sets the value of the DisconnectedText property, the text that appears centered in the control before a connection is terminated.

HRESULT put_DisconnectedText(
  BSTR disconnectText
);

Parameters

  • disconnectText
    [in] The string value DisconnectedText is to be set to.

Return Values

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

OS Versions: Windows CE .NET 4.0 and later.
Header: Discodlg.h. Mstsax.idl.
Link Library: Mstsax.lib.

See Also

IMsTscAx | IMsTscAx::get_DisconnectedText

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.