IRemoteDesktopClientSettings::SetRdpProperty method

[This documentation is preliminary and is subject to change.]

Applies to: desktop apps | Metro style apps

Sets the value of a single named RDP property.

Syntax

HRESULT SetRdpProperty(
  [in]  BSTR propertyName,
  [in]  VARIANT value
);

Parameters

propertyName [in]

A string that specifies the name of the property. This can be one of the following values.

Note  These string values are not case-sensitive.

Property nameData typeMeaning

"administrative session"

VT_BOOL

Specifies whether the session is an administrative session. This can be one of the following values.

ValueDescription
VT_FALSEThe session is not an administrative session.
VT_TRUEThe session is an administrative session.

 

"allow font smoothing"

VT_BOOL

Specifies whether font smoothing is allowed in the remote session. This can be one of the following values.

ValueDescription
VT_FALSEFont smoothing is not allowed.
VT_TRUEFont smoothing is allowed.

 

"alternate full address"

VT_BSTR

Specifies an alternate name or IP address of the remote computer that you want to connect to.

"audiocapturemode"

VT_I4

Specifies the audio input capture mode. This can be one of the following values.

ValueDescription
0Do not capture audio input.
1Capture audio input.

 

"audiomode"

VT_I4

Specifies where sounds are played. This can be one of the following values.

ValueDescription
0Play sounds on the client computer.
1Play sounds on the host computer.
2Do not play sounds.

 

"authentication level"

VT_I4

Specifies the authentication level of the remote session. This can be one of the following values.

ValueDescription
0None.
1Authentication required.
2Authentication negotiable.
3Authentication unspecified.

 

"connection type"

VT_I4

Specifies the connection type This can be one of the following values.

ValueDescription
0Modem
1Low speed broadband
2Satellite
3High speed broadband
4WAN
5LAN
6Auto detect

 

"cookie based authentication server address"

VT_BSTR

Specifies the address of the cookie-based authentication server.

"desktopheight"

VT_I4

Specifies the height, in pixels, of the virtual desktop.

"desktopwidth"

VT_I4

Specifies the width, in pixels, of the virtual desktop.

"disable full window drag"

VT_BOOL

Specifies whether showing window contents while dragging is disabled. This can be one of the following values.

ValueDescription
VT_FALSEEnabled
VT_TRUEDisabled

 

"disable menu anims"

VT_BOOL

Specifies whether showing menu animations is disabled. This can be one of the following values.

ValueDescription
VT_FALSEEnabled
VT_TRUEDisabled

 

"disable themes"

VT_BOOL

Specifies whether themes are disabled. This can be one of the following values.

ValueDescription
VT_FALSEEnabled
VT_TRUEDisabled

 

"disable wallpaper"

VT_BOOL

Specifies whether wallpapers are displayed. This can be one of the following values.

ValueDescription
VT_FALSEWallpapers are displayed.
VT_TRUEWallpapers are not displayed.

 

"domain"

VT_BSTR

Specifies the domain used to connect to the remote session.

"enablecredsspsupport"

VT_BOOL

Specifies whether to use CredSSP-based authentication for the remote session. This can be one of the following values.

ValueDescription
VT_FALSEDo not use CredSSP-based authentication.
VT_TRUEUse CredSSP-based authentication.

 

"full address"

VT_BSTR

Specifies the address of the computer being connected to.

"gatewaycredentialssource"

VT_I4

Specifies the source for credentials for the Remote Desktop gateway. This can be one of the following values.

ValueDescription
0Prompt the user for their credentials and use NTLM authentication.
1Use a smart card for credentials.
2Use the credentials for the currently logged on user.
3Prompt the user for their credentials and use basic authentication.
4The user will select the credential source at logon.
5Use cookie-based authentication.

 

"gatewayhostname"

VT_BSTR

Specifies the Remote Desktop gateway server name.

"gatewayprofileusagemethod"

VT_I4

Specifies the Remote Desktop gateway profile usage. This can be one of the following values.

ValueDescription
0Use the gateway profile settings, if present.
1Use the explicit gateway settings, even if a gateway profile exists.

 

"gatewayusagemethod"

VT_I4

Specifies the Remote Desktop gateway usage. This can be one of the following values.

ValueDescription
0Do not use a Remote Desktop gateway server. The Bypass RD Gateway server for local addresses check box is cleared.
1Use the Remote Desktop gateway specified by the "gatewayhostname" property.
2Automatically detect the Remote Desktop gateway server settings.
3Use the default settings Remote Desktop gateway usage settings.
4Do not use a Remote Desktop gateway server. The Bypass RD Gateway server for local addresses check box is selected.

 

"high resolution mouse"

VT_I4

Specifies the resolution mode for mouse input. This can be one of the following values.

ValueDescription
0Mouse input will be coalesced. Mouse data will be subsampled and sent according to the default sampling rate.
1Mouse input will not be coalesced. Mouse data will be sent at full resolution.

 

"loadbalanceinfo"

VT_BSTR

Contains the load balancing cookie used to choose the best server for the client computer.

"login web page address"

VT_BSTR

Specifies the address of the login webpage.

"pre-authentication server address"

VT_BSTR

Specifies the address of the preauthentication server.

"prompt for credentials"

VT_BOOL

Specifies whether the user will be prompted for their credentials. This can be one of the following values.

ValueDescription
VT_FALSEThe user will not be prompted for credentials.
VT_TRUEThe user will be prompted for credentials.

 

"promptcredentialonce"

VT_I4

Specifies whether credential sharing for the Remote Desktop gateway is enabled. This can be one of the following values.

ValueDescription
0Credential sharing is disabled.
1Credential sharing is enabled.

 

"redirectclipboard"

VT_BOOL

Specifies whether the clipboard for the client is redirected to the remote session. This can be one of the following values.

ValueDescription
VT_FALSEThe clipboard is not redirected.
VT_TRUEThe clipboard is redirected.

 

"redirectprinters"

VT_BOOL

Specifies whether the printers for the client are redirected to the remote session. This can be one of the following values.

ValueDescription
VT_FALSEThe printers are not redirected.
VT_TRUEThe printers are redirected.

 

"require pre-authentication"

VT_BOOL

Specifies whether preauthentication is required. This can be one of the following values.

ValueDescription
VT_FALSEPre-authentication is not required.
VT_TRUEPre-authentication is required.

 

"support url"

VT_BSTR

Specifies the URL to obtain support information from.

"use redirection server name"

VT_BOOL

Specifies whether a redirection server is allowed. This can be one of the following values.

ValueDescription
VT_FALSEA redirection server is not allowed.
VT_TRUEA redirection server is allowed.

 

"username"

VT_BSTR

Specifies the user name used to connect to the remote session.

"Workspace Id"

VT_BSTR

Specifies the identifier of the RemoteApp and Desktop Connection workspace which this RDP file has been published as part of.

 

value [in]

The new property value.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Examples

The following JavaScript code example shows how to use this method to set a named property.


function SetFullAddressProperty(rdpControl, fullAddress)
{
    rdpControl.Settings.SetRdpProperty("Full Address", fullAddress);
}


Requirements

Minimum supported client

Windows 8 Consumer Preview

Minimum supported server

Windows Server 8 Beta

IDL

Rdpappcontainerclient.idl

See also

IRemoteDesktopClientSettings

 

 

Send comments about this topic to Microsoft

Build date: 4/21/2012

Community Additions

Show: