Skip to main content

Windows Dev Center

IMsTscAx::Domain property

Specifies the domain to which the current user logs on.

This property is read/write.

Syntax


HRESULT put_Domain(
  [in]  BSTR newVal
);

HRESULT get_Domain(
  [out] BSTR *pDomain
);

Property value

The new domain name.

Error codes

Return S_OK if successful.

Remarks

Setting the Domain property is optional. If it is not set, the user can choose a domain when the Windows Logon dialog box appears during the connection.

The get_Domain method allocates the memory required for the buffer pointed to by the pDomain 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.

This property can be set only if the control is not in the connected state. It returns E_FAIL if it is called when the control is connected. You can check if the control is connected by responding to connection events in IMsTscAxEvents or examining the Connected property.

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
Connected
IMsTscAx
IMsTscAxEvents