Share via


IMsTscAx::put_Server

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method sets the value of the Server property, which is the name of the server to be connected to.

Syntax

HRESULT put_Server(
  BSTR serverProperty
);

Parameters

  • serverProperty
    [in] The string value the Server property is set to.

Return Value

This following table shows the return values for this method.

Value Description

S_OK

The Server property was correctly set.

E_FAIL

The control is already connected or in the connecting state.

nonzero error code

An error occurred.

Remarks

The Server property can be a DNS name or IP address.

Server must be set before calling the IMsTscAx::Connect method. It is the only property that must be set before connecting.

The Server 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

See Also

Reference

IMsTscAx
IMsTscAx::get_Server