IMsTscAx::UserName property

Specifies the user name logon credential.

This property is read/write.

Syntax

HRESULT put_UserName(
  [in]  BSTR newVal
);

HRESULT get_UserName(
  [out] BSTR *pUserName
);

Property value

The new user name.

Error codes

Return S_OK if successful.

Remarks

Setting the UserName property is optional. If it is not specified, the user can provide a user name when the Windows Logon dialog box appears during connection.

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.

The get_UserName property method allocates the memory required for the buffer pointed to by the pVersion 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 2008
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

IMsRdpClient9

IMsTscAx