IMsTscAx::Server property

Specifies the name of the server to which the current control is connected.

This property is read/write.

Syntax


HRESULT put_Server(
  [in]   BSTR newVal
);

HRESULT get_Server(
  [out]  BSTR *pServer
);

Property value

The new server name. This parameter can be a DNS name or IP address.

Error codes

If the methods succeed, S_OK is returned. Any other HRESULT value indicates that the call failed.

Remarks

This property must be set before calling the Connect method. It is the only property that must be set before connecting.

This property can be set only if the control is not in the connected state. This property returns E_FAIL if it is called when the control is connected. You can check for the connected state by using the Connected property.

This method allocates the memory required for the buffer pointed to by the pServer parameter. Calling C/C++ applications must free the memory with a call to the SysFreeString function. This is not required for Visual Basic and scripting clients.

For more information about Remote Desktop Web Connection, see Requirements for Remote Desktop Web Connection.

Requirements

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2003

Type library

Mstscax.dll

DLL

Mstscax.dll

IID

IID_IMsTscAx is defined as 8C11EFAE-92C3-11D1-BC1E-00C04FA31489

See also

IMsRdpClient
IMsRdpClient2
IMsRdpClient3
IMsRdpClient4
IMsRdpClient5
IMsRdpClient6
IMsRdpClient7
IMsRdpClient8
IMsTscAx

 

 

Show:
© 2014 Microsoft