Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

IMsRdpClientAdvancedSettings::ConnectToServerConsole property

[This property is not supported. Starting with Windows Server 2008, Windows Vista, and Windows XP with Service Pack 3 (SP3), calls to ConnectToServerConsole always return S_FALSE.]

Specifies if the control should attempt to connect to the console session of a server. The default value is VARIANT_FALSE, which specifies that the control should not attempt to connect to the console. VARIANT_TRUE, which specifies that the control should attempt to connect to the console, is supported beginning with Windows Server 2003.

Use the ConnectToAdministerServer property to connect to the session that is used for administrative purposes on a Windows Server 2008-based server, or to the console session on a Windows Server 2003-based server.

This property is read/write.

Syntax


HRESULT put_ConnectToServerConsole(
  [in]   VARIANT_BOOL connectToServerConsole
);

HRESULT get_ConnectToServerConsole(
  [out]  VARIANT_BOOL *pconnectToServerConsole
);

Property value

Set this parameter to VARIANT_FALSE to disable the feature or VARIANT_TRUE to enable the feature. The default value is VARIANT_FALSE. Note that VARIANT_TRUE (which specifies that the control should attempt to connect to the console) is supported in Windows Server 2003.

Error codes

Returns S_OK if successful.

Remarks

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

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

End of client support

Windows XP with SP2

End of server support

Windows Server 2003

Type library

Mstscax.dll

DLL

Mstscax.dll

IID

IID_IMsRdpClientAdvancedSettings is defined as 3c65b4ab-12b3-465b-acd4-b8dad3bff9e2

See also

IMsRdpClientAdvancedSettings2
IMsRdpClientAdvancedSettings3
IMsRdpClientAdvancedSettings4
IMsRdpClientAdvancedSettings5
IMsRdpClientAdvancedSettings

 

 

Show:
© 2014 Microsoft. All rights reserved.