Export (0) Print
Expand All

IMsRdpClientAdvancedSettings interface

Manages advanced client settings. Derives from the IMsTscAdvancedSettings interface. This interface includes methods to retrieve and set advanced (optional) properties for the Remote Desktop ActiveX control.

To obtain an instance of this interface, use the IMsTscAx::AdvancedSettings property to obtain an IMsTscAdvancedSettings interface pointer. Then call QueryInterface on the IMsTscAdvancedSettings pointer, passing IID_IMsRdpClientAdvancedSettings.

Members

The IMsRdpClientAdvancedSettings interface inherits from IMsTscAdvancedSettings. IMsRdpClientAdvancedSettings also has these types of members:

Properties

The IMsRdpClientAdvancedSettings interface has these properties.

PropertyAccess typeDescription

AcceleratorPassthrough

Read/write

Specifies if keyboard accelerators should be passed to the server.

BitmapCacheSize

Read/write

The size, in kilobytes, of the bitmap cache file used for 8-bits-per-pixel bitmaps. Valid numeric values of this property are 1 to 32 inclusive.

BitmapPersistence

Read/write

Specifies if persistent bitmap caching should be used. Persistent caching can improve performance but requires additional disk space.

BitmapVirtualCache16BppSize

Read/write

Specifies the size, in megabytes, of the persistent bitmap cache file to use for the 15 and 16 bits-per-pixel high-color settings.

BitmapVirtualCache24BppSize

Read/write

Specifies the size, in megabytes, of the persistent bitmap cache file to use for the 24 bits-per-pixel high-color setting.

BitmapVirtualCacheSize

Read/write

Specifies the size, in megabytes, of the persistent bitmap cache file to use for 8-bits-per-pixel color. Valid numeric values of this property are 1 to 32 inclusive. Note that the maximum size for all virtual cache files is 128 MB. Related properties include the BitmapVirtualCache16BppSize and BitmapVirtualCache24BppSize properties.

brushSupportLevel

Read/write

This property is not supported.

CachePersistenceActive

Read/write

Specifies whether persistent bitmap caching should be used.

ClearTextPassword

Write-only

Specifies the password with which to connect. For more information, see the IMsTscNonScriptable interface.

ConnectToServerConsole

Read/write

This property is not supported.

Windows Server 2003:  

Specifies if the control should attempt to connect to the console session of a server.

ConnectWithEndpoint

Write-only

This property is not supported.

DedicatedTerminal

Read/write

This property is not supported.

DisableCtrlAltDel

Read/write

Specifies if the initial explanatory screen in Winlogon should display.

DisplayConnectionBar

Read/write

Specifies whether to use the connection bar. The default value is VARIANT_TRUE, which enables the property.

DoubleClickDetect

Read/write

Specifies if the client identifies double-clicks for the server.

EnableMouse

Read/write

This property is not supported.

EnableWindowsKey

Read/write

Specifies if the Windows key can be used in the remote session.

EncryptionEnabled

Read/write

This property is not supported. Encryption cannot be disabled.

GrabFocusOnConnect

Read/write

Specifies if the client control should have the focus while connecting.

HotKeyAltEsc

Read/write

Specifies the virtual-key code to add to ALT to determine the hotkey replacement for ALT+ESC. VK_INSERT is the default value, with ALT+INSERT as the resulting sequence. This property is valid only when the KeyboardHookMode property is not enabled.

HotKeyAltShiftTab

Read/write

Specifies the virtual-key code to add to ALT to determine the hotkey replacement for ALT+SHIFT+TAB. VK_NEXT is the default value, with ALT+PAGE DOWN as the resulting sequence. This property is valid only when the KeyboardHookMode property is not enabled.

HotKeyAltSpace

Read/write

Specifies the virtual-key code to add to ALT to determine the hotkey replacement for ALT+SPACE. VK_DELETE is the default, with ALT+DELETE as the resulting sequence. This property is valid only when the KeyboardHookMode property is not enabled.

HotKeyAltTab

Read/write

Specifies the virtual-key code to add to ALT to determine the hotkey replacement for ALT+TAB. VK_PRIOR is the default value, with ALT+PAGE UP as the resulting sequence. This property is valid only when the KeyboardHookMode property is not enabled.

HotKeyCtrlAltDel

Read/write

Specifies the virtual-key code to add to CTRL+ALT to determine the hotkey replacement for CTRL+ALT+DELETE, also called the secure attention sequence (SAS). VK_END is the default. Note that even when the KeyboardHookMode property is enabled, CTRL+ALT+DELETE is never redirected to the remote server; CTRL+ALT+DELETE is the local SAS sequence.

HotKeyCtrlEsc

Read/write

Specifies the virtual-key code to add to ALT to determine the hotkey replacement for CTRL+ESC. VK_HOME is the default value, with ALT+HOME as the resulting sequence. This property is valid only when the KeyboardHookMode property is not enabled.

HotKeyFullScreen

Read/write

Specifies the virtual-key code to add to CTRL+ALT to determine the hotkey replacement for switching to full-screen mode. VK_CANCEL is the default value.

InputEventsAtOnce

Read/write

This property is not supported.

keepAliveInterval

Read/write

Specifies an interval, in milliseconds, at which the client sends keep-alive messages to the server. The default value of the property is zero, which disables keep-alive messages. The minimum valid value of this property is 10,000, which represents 10 seconds. Note that a group policy setting that specifies whether persistent client connections to the server are allowed can override this property setting.

KeyboardFunctionKey

Read/write

Valid for Windows CE only.

KeyboardSubType

Read/write

Valid for Windows CE only.

KeyboardType

Read/write

Valid for Windows CE only.

LoadBalanceInfo

Read/write

Specifies the load balancing cookie that will be placed in the X.224 Connection Request packet in the RD Session Host server protocol connection sequence.

maxEventCount

Read/write

This property is not supported.

MaximizeShell

Read/write

Specifies if programs launched with the StartProgram property should be maximized.

minInputSendInterval

Read/write

Specifies the minimum interval, in milliseconds, between the sending of mouse events.

MinutesToIdleTimeout

Read/write

Specifies the maximum length of time, in minutes, that the client should remain connected without user input. If the specified time elapses, the control calls the IMsTscAxEvents::OnIdleTimeoutNotification method.

NotifyTSPublicKey

Read/write

This property is not supported.

NumBitmapCaches

Read/write

This property is not supported.

orderDrawThreshold

Read/write

This property is not supported.

overallConnectionTimeout

Read/write

Specifies the total length of time, in seconds, that the client control waits for a connection to complete. The maximum valid value of this property is 600, which represents 10 minutes. If the specified time elapses before connection completes, the control disconnects and calls the IMsTscAxEvents::OnDisconnected method. A related property is singleConnectionTimeout.

PerformanceFlags

Read/write

Specifies a set of features that can be set at the server to improve performance.

PersistCacheDirectory

Write-only

This property is not supported.

PinConnectionBar

Read/write

Specifies the state of the UI connection bar. Setting this property to VARIANT_TRUE sets the state to "lowered", that is, invisible to the user and unavailable for input. VARIANT_FALSE sets the state to "raised" and available for user input.

RdpdrClipCleanTempDirString

Read/write

This property is not supported.

RdpdrClipPasteInfoString

Read/write

This property is not supported.

RdpdrLocalPrintingDocName

Read/write

This property is not supported.

RDPPort

Read/write

Specifies the connection port. The default value is 3389.

RedirectDrives

Read/write

Specifies if redirection of disk drives is allowed.

RedirectPorts

Read/write

Specifies if redirection of local ports (for example, COM and LPT) is allowed.

RedirectPrinters

Read/write

Specifies if redirection of printers is allowed.

RedirectSmartCards

Read/write

Specifies if redirection of smart cards is allowed.

SasSequence

Read/write

Specifies the secure access sequence the client will use to access the login screen on the server.

ScaleBitmapCachesByBPP

Read/write

This property is not supported.

ShadowBitmap

Read/write

This property is not supported.

Windows Vista and Windows Server 2003:  Specifies if shadow bitmaps should be used.

shutdownTimeout

Read/write

Specifies the length of time, in seconds, to wait for the server to respond to a disconnection request. The default value of the property is 10. The maximum valid value of the property is 600, which represents 10 minutes. If the server does not reply within the specified time, the client control disconnects.

singleConnectionTimeout

Read/write

Specifies the maximum length of time, in seconds, that the client control waits for a connection to an IP address. During connection the control may attempt to connect to multiple IP addresses. The maximum valid value of this property is 600. A related property is overallConnectionTimeout.

SmartSizing

Read/write

Specifies if the display should be scaled to fit the client area of the control. VARIANT_TRUE enables scaling. Note that scroll bars do not appear when the SmartSizing property is enabled.

SmoothScroll

Read/write

This property is not supported.

TransportType

Read/write

Specifies the transport type used by the client. This property is not used by the Remote Desktop ActiveX control.

WinCEFixedPalette

Read/write

Valid for Windows CE only.

 

Remarks

This interface has been extended by the following interfaces, with each new interface inheriting all the methods and properties of the previous interfaces:

This property cannot be set when the control is connected, unless otherwise indicated.

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_IMsRdpClientAdvancedSettings is defined as 3c65b4ab-12b3-465b-acd4-b8dad3bff9e2

See also

Remote Desktop Web Connection Reference
IMsTscAdvancedSettings

 

 

Show:
© 2015 Microsoft