IMsRdpClientAdvancedSettings
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This interface includes methods to retrieve and set advanced (optional) properties for the Remote Desktop ActiveX control. This interface was added for Windows XP.
IMsRdpClientAdvancedSettings derives from the IMsTscAdvancedSettings interface. It inherits all the IMsTscAdvancedSettings methods and provides additional methods to access additional properties.
Methods
The IMsRdpClientAdvancedSettings interface provides the following methods.
- IUnknown methods
- IDispatch methods
- IMsTscAdvancedSettings methods
- IMsRdpClientAdvancedSettings methods
The following tables show the methods on the IMSRdpClientAdvancedSettings interface.
Bitmap and Caching Methods
| Method | Description |
|---|---|
Sets or retrieves the BitmapCacheSize property value, which is the size, in kilobytes (KB), of the bitmap cache file used for 8 bits-per-pixel (bpp) color settings. |
|
Sets or retrieves the BitmapPersistence property value, a LONG value that specifies whether persistent bitmap caching is enabled. |
|
Sets or retrieves the BitmapVirtualCacheSize property value, which specifies the size, in KB, of the persistent bitmap cache file to use for 8 bpp color settings. |
|
Sets or retrieves the BitmapVirtualCache16BppSize property value, which specifies the size, in KB, of the persistent bitmap cache file to use for the 15 and 16 bpp high-color settings. |
|
Sets or retrieves the BitmapVirtualCache24BppSize property value, which specifies the size, in KB, of the persistent bitmap cache file to use for the 24 bpp high-color settings. |
|
Sets or retrieves the NumBitmapCaches property value, which specifies the number of bitmap caches to use. |
|
Sets the PersistCacheDirectory property value, which is a string specifying the path to the directory for storage of bitmap cache files. Note that this property is write-only. |
|
Sets or retrieves the ScaleBitmapCachesByBPP property value, which specifies whether the size of bitmap caches should be scaled by bit depth (bits per pixel). |
|
Sets or retrieves the ShadowBitmap property value, which specifies whether shadow bitmaps will be used. |
Connection, Timeout, Interval, and Event Methods
| Method | Description |
|---|---|
Sets or retrieves the ConnectToServerConsole property value, which specifies whether the ActiveX client control should attempt to connect to the console session of a server. |
|
Sets or retrieves the DisplayConnectionBar property value, which specifies whether the connection bar appears when you log on to the remote computer in full-screen mode. |
|
Sets or retrieves the GrabFocusOnConnect property value, which specifies whether the ActiveX client control will obtain the UI focus from a window running in a different process while it is connecting to the server. |
|
Sets or retrieves the InputEventsAtOnce property value, which specifies the typical number of input events to batch together. This method is no longer supported and always returns S_FALSE. |
|
Sets or retrieves the KeepAliveInterval property value, which specifies an interval, in milliseconds, at which the client sends keep-alive messages to the server. This method is no longer supported and always returns S_FALSE. |
|
Sets or retrieves the MaxEventCount property value, which specifies the maximum number of input events to batch together. This method is no longer supported and always returns S_FALSE. |
|
Sets or retrieves the MinInputSendInterval property value, which specifies the minimum interval, in milliseconds, between the sending of mouse events. This method is no longer supported and always returns S_FALSE. |
|
Sets or retrieves the MinutesToIdleTimeout property value, which specifies the maximum length of time, in minutes, that the client should remain connected while there is no user input. |
|
Sets or retrieves the OverallConnectionTimeout property value, which specifies the total length of time, in seconds, that the ActiveX client control waits for a connection to complete. |
|
Sets or retrieves the PinConnectionBar property value, which indicates whether the connection bar will be pinned to the shell. |
|
Sets or retrieves the RDPPort property value, which indicates the server connection port for Remote Desktop Protocol (RDP) connections.. |
|
Sets or retrieves the ShutdownTimeout property value, which indicates the length of time, in seconds, to wait for the server to respond to a disconnect request. If the server does not reply within the specified time, the ActiveX client control disconnects. |
|
Sets or retrieves the SingleConnectionTimeout property value, which specifies the maximum time, in seconds, the ActiveX client control waits for a connection to an IP address. |
Keyboard and Mouse Methods
| Method | Description |
|---|---|
Sets or retrieves the AcceleratorPassthrough property value, which indicates whether keyboard accelerators should be passed to the remote server. |
|
Sets or retrieves the DisableCtrlAltDel property value, which indicates whether the initial explanatory screen in Winlogon, which prompts you to unlock your computer, should appear. |
|
Sets or retrieves the DoubleClickDetect property value, which indicates whether the client detects mouse double-clicks for the remote server. |
|
Sets or retrieves the EnableMouse property value, which specifies whether the ActiveX client control sends mouse-button messages to the remote server. |
|
Sets or retrieves the EnableWindowsKey property value, which specifies whether the Windows key can be used during a remote session. |
|
Sets or retrieves the HotKeyAltEsc property value, which is the virtual-key code to add to assign to the ALT+ESC key combination to determine the keyboard-shortcut replacement. |
|
Sets or retrieves the HotKeyAltShiftTab property value, which is the virtual-key code to assign to the ALT+SHIFT+TAB key combination to determine the keyboard-shortcut replacement. |
|
Sets or retrieves the HotKeyAltSpace property value, which is the virtual-key code to assign to ALT+SPACE to determine the keyboard-shortcut replacement. |
|
Sets or retrieves the HotKeyAltTab property value, which is the virtual-key code to assign to ALT+TAB to determine the keyboard-shortcut replacement. |
|
Sets or retrieves the HotKeyCtrlAltDel property value, which is the virtual-key code to assign to CTRL+ALT+DEL to determine the keyboard-shortcut replacement. |
|
Sets or retrieves the HotKeyCtrlEsc property value, which is the virtual-key code to assign to CTRL+ESC to determine the keyboard-shortcut replacement. |
|
Sets or retrieves the HotKeyFullScreen property value, which is the virtual-key code to detect for switching to full-screen mode. |
|
Sets or retrieves the KeyboardFunctionKey property value, which indicates the number of keyboard function keys. |
|
Sets or retrieves the KeyboardSubType property value, which indicates the subtype of the keyboard that is attached to the client computer. |
|
Sets or retrieves the KeyboardType property value, which indicates the type of keyboard that is attached to the client computer. |
Redirection Methods
| Method | Description |
|---|---|
Sets or retrieves the RedirectDrives property value, which indicates whether disk-drive redirection is enabled. |
|
Sets or retrieves the RedirectPorts property value, which specifies whether redirection of local ports (for example, COM and LPT) is enabled. |
|
Sets or retrieves the RedirectPrinters property value, which specifies whether printer redirection is enabled. |
|
Sets or retrieves the RedirectSmartCards property value, which specifies whether smart-card redirection is enabled. |
Customization and Performance Methods
| Method | Description |
|---|---|
Sets or retrieves the DedicatedTerminal property value, which specifies whether the client should run in dedicated-terminal mode. This method is no longer supported and always returns S_FALSE. |
|
get_EncryptionEnabled, put_EncryptionEnabled |
Reserved. You cannot disable encryption. |
Sets or retrieves the MaximizeShell property value, which specifies whether programs launched with the StartProgram property will appear with a maximized window. |
|
Sets or retrieves the OrderDrawThreshold property value, which specifies the maximum number of drawing operations to batch together for rendering. This method is no longer supported and always returns S_FALSE. |
|
Sets or retrieves the PerformanceFlags property value, which is a flag set specifying the set of features at the remote server that are made unavailable to improve performance. |
|
Sets or retrieves the RdpdrLocalPrintingDocName property value, which is a string that specifies the name to use for printer documents that are redirected; for example, Remote Desktop Redirected Printer Document. This method is no longer supported and always returns S_FALSE. |
|
Sets or retrieves the RdpdrClipCleanTempDirString property value, which is a string that specifies the message to display before exiting while the client control is deleting files in a temporary directory; for example, Cleaning up temporary directory. This method is no longer supported and always returns S_FALSE. |
|
Sets or retrieves the RdpdrClipPasteInfoString property value, which is a string that specifies the message to display while the client control processes clipboard information in preparation for pasting the data; for example, Preparing to paste information. This method is no longer supported and always returns S_FALSE. |
|
get_SasSequence, put_SasSequence |
Reserved. |
Sets or retrieves the SmartSizing property value, which specifies whether the display should be scaled to fit the client area of the ActiveX client control. Scroll bars do not appear when SmartSizing is enabled. |
|
Sets or retrieves the SmoothScroll property value, which specifies whether the Remote Desktop window should scroll smoothly when scroll bars are used. This method is no longer supported and always returns S_FALSE. |
|
get_TransportType , put_TransportType |
Reserved. |
get_WinCEFixedPalette, put_WinCEFixedPalette |
Unsupported. Returns E_NOTIMPL. |
Sets the value of the ClearTextPassword property, which specifies the password for the Remote Desktop ActiveX control, in clear-text format. This property is write-only. |
|
Sets a value that indicates the connected socket that the ActiveX client control will connect to. This property is write-only. |
Obtaining a Pointer
To obtain an IMsRdpClientAdvancedSettings interface pointer, call IMsRdpClient::get_AdvancedSettings2.
Remarks
For an alphabetic list of the properties, see IMsRdpClientAdvancedSettings Properties.
For a description of each property, information about its syntax, and a functional grouping of the properties, see IMsRdpClientAdvancedSettings Property Descriptions.
Requirements
| Header | mstsax.h, mstsax.idl |
| Library | Mstsax.lib |
| Windows Embedded CE | Windows CE .NET 4.0 and later |