IMsRdpClientAdvancedSettings (Windows CE 5.0)
This interface includes methods to retrieve and set advanced (optional) properties for the Remote Desktop ActiveX control. This interface was added for Microsoft Windows XP.
IMsRdpClientAdvancedSettings derives from the IMsTscAdvancedSettings interface. It includes all the IMsTscAdvancedSettings methods and provides access to additional properties.
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.
Methods
The IMsRdpClientAdvancedSettings interface contains the following methods.
- IUnknown methods
- IDispatch methods
- IMsTscAdvancedSettings methods
- IMsRdpClientAdvancedSettings methods
The following table shows the methods for the IMSRdpClientAdvancedSettings interface.
| Method | Description |
|---|---|
| put_SmoothScroll get_SmoothScroll |
Sets or retrieves the SmoothScroll property value, which specifies whether the Remote Desktop window should scroll smoothly when scroll bars are used. The default is a nonzero value, which enables smooth scrolling and increases the scrolling response on slower computers. The property has no effect on scrolling in the actual remote session. |
| put_AcceleratorPassthrough get_AcceleratorPassthrough |
Sets or retrieves the AcceleratorPassthrough property value, which specifies whether keyboard accelerators should be passed to the server. The default is a nonzero value, which enables accelerators. |
| put_ShadowBitmap get_ShadowBitmap |
Sets or retrieves the ShadowBitmap property value, which specifies whether shadow bitmaps should be used. Shadowing allows a user to remotely monitor the on-screen operation of another user. Setting this property to zero disables the property, which typically improves performance but can result in artifacts when painting screens. |
| put_TransportType get_TransportType |
Reserved. |
| put_SasSequence get_SasSequence |
Reserved. |
| put_EncryptionEnabled get_EncryptionEnabled |
Reserved. You cannot disable encryption. |
| put_DedicatedTerminal get_DedicatedTerminal |
Sets or retrieves the DedicatedTerminal property value, which specifies whether the client should run in dedicated-terminal mode. Setting this property to a nonzero value indicates the client should run in dedicated-terminal mode. This property is intended primarily for use by Microsoft® Windows® CE–based devices to specify screen-painting characteristics. |
| put_RDPPort get_RDPPort |
Sets or retrieves the RDPPort property value, which specifies the connection port. The default value is 3389. |
| put_EnableMouse get_EnableMouse |
Sets or retrieves the EnableMouse property value, which specifies whether the client sends mouse-button messages to the server. Setting this property to a nonzero value indicates the client sends mouse-button messages. |
| put_DisableCtrlAltDel get_DisableCtrlAltDel |
Sets or retrieves the DisableCtrlAltDel property value, which specifies whether the initial explanatory screen in Winlogon should display. The default is a nonzero value, which prevents display of the screen. |
| put_EnableWindowsKey get_EnableWindowsKey |
Sets or retrieves the EnableWindowsKey property value, which specifies whether the Windows key can be used in the remote session. Setting this property to a nonzero value indicates that the key can be used. |
| put_DoubleClickDetect get_DoubleClickDetect |
Sets or retrieves the DoubleClickDetect property value, which specifies whether the client identifies double-clicks for the server. Setting this property to a nonzero value indicates the client identifies double-clicks. |
| put_MaximizeShell get_MaximizeShell |
Sets or retrieves the MaximizeShell property value, which specifies whether programs launched with the StartProgram property should be maximized. The default is a nonzero value, which maximizes programs. |
| put_HotKeyFullScreen get_HotKeyFullScreen |
Sets or retrieves the HotKeyFullScreen property value, which is 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. For a table that lists the names of the symbolic constants, hexadecimal values, and mouse or keyboard equivalents for the virtual-key codes used by the system, see Virtual-Key Codes. |
| put_HotKeyCtrlEsc get_HotKeyCtrlEsc |
Sets or retrieves the HotKeyCtrlEsc property value, which is the virtual-key code to add to CTRL+ALT to determine the hotkey replacement for CTRL+ESC. VK_HOME is the default value. This property is valid only when the KeyboardHookMode property is not enabled. |
| put_HotKeyAltEsc get_HotKeyAltEsc |
Sets or retrieves the HotKeyAltEsc property value, which is the virtual-key code to add to CTRL+ALT to determine the hotkey replacement for ALT+ESC. VK_INSERT is the default value. This property is valid only when the KeyboardHookMode property is not enabled. |
| put_HotKeyAltTab get_HotKeyAltTab |
Sets or retrieves the HotKeyAltTab property value, which is the virtual-key code to add to CTRL+ALT to determine the hotkey replacement for ALT+TAB. VK_PRIOR is the default value. This property is valid only when the KeyboardHookMode property is not enabled. |
| put_HotKeyAltShiftTab get_HotKeyAltShiftTab |
Sets or retrieves the HotKeyAltShiftTab property value, which is the virtual-key code to add to CTRL+ALT to determine the hotkey replacement for ALT+SHIFT+TAB. VK_NEXT is the default value. This property is valid only when the KeyboardHookMode property is not enabled. |
| put_HotKeyAltSpace get_HotKeyAltSpace |
Sets or retrieves the HotKeyAltSpace property value, which is the virtual-key code to add to CTRL+ALT to determine the hotkey replacement for ALT+SPACE. VK_DELETE is the default value. This property is valid only when the KeyboardHookMode property is not enabled. |
| put_HotKeyCtrlAltDel get_HotKeyCtrlAltDel |
Sets or retrieves the HotKeyCtrlAltDel property value, which is 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 value. 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. |
| put_OrderDrawThreshold get_OrderDrawThreshold |
Sets or retrieves the OrderDrawThreshold property value, which specifies the maximum number of drawing operations to batch together for rendering. |
| put_BitmapCacheSize get_BitmapCacheSize |
Sets or retrieves the BitmapCacheSize property value, which is the size, in KB, of the bitmap cache file used for 8 bits per pixel bitmaps. |
| put_BitmapVirtualCacheSize get_BitmapVirtualCacheSize |
Sets or retrieves the BitmapVirtualCacheSize property value, which specifies the size, in KB, of the persistent bitmap cache file to use for 8 bits per pixel color. Note that the maximum size for all virtual cache files is 128 KB. Related properties include the BitmapVirtualCache16BppSize and BitmapVirtualCache24BppSize properties. |
| put_ScaleBitmapCachesByBPP get_ScaleBitmapCachesByBPP |
Sets or retrieves the ScaleBitmapCachesByBPP property value, which specifies whether the size of bitmap caches should be scaled by bit depth (bits per pixel). It is recommended that you leave this property at its default value, enabled or nonzero. |
| put_NumBitmapCaches get_NumBitmapCaches |
Sets or retrieves the NumBitmapCaches property value, which specifies the number of bitmap caches to use. The default value is 3, which results in the best performance. |
| put_PersistCacheDirectory | 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. |
| put_MinInputSendInterval get_MinInputSendInterval |
Sets or retrieves the MinInputSendInterval property value, which specifies the minimum interval, in milliseconds, between the sending of mouse events. The default value is 100. |
| put_InputEventsAtOnce get_InputEventsAtOnce |
Sets or retrieves the InputEventsAtOnce property value, which specifies the typical number of input events to batch together. The default value is 10. |
| put_MaxEventCount get_MaxEventCount |
Sets or retrieves the MaxEventCount property value, which specifies the maximum number of input events to batch together. The default value is 100. |
| put_KeepAliveInterval get_KeepAliveInterval |
Sets or retrieves the KeepAliveInterval property value, which specifies an interval, in milliseconds, at which the client sends keep-alive messages to the server. The default value is zero, which disables keep-alive messages. Note that a Group Policy setting that specifies whether persistent client connections to the server are allowed can override this property setting. |
| put_ShutdownTimeout get_ShutdownTimeout |
Sets or retrieves the ShutdownTimeout property value, which specifies the length of time, in seconds, to wait for the server to respond to a disconnection request. The default value is 10 seconds. If the server does not reply within the specified time, the client control disconnects. |
| put_OverallConnectionTimeout get_OverallConnectionTimeout |
Sets or retrieves the OverallConnectionTimeout property value, which specifies the total length of time, in seconds, that the client control waits for a connection to complete. If the specified time elapses before connection completes, the control disconnects and calls IMsTscAxEvents::OnDisconnected. A related property is SingleConnectionTimeout. |
| put_SingleConnectionTimeout get_SingleConnectionTimeout |
Sets or retrieves the SingleConnectionTimeout property value, which specifies the maximum length of time, in seconds, the client control waits for a connection to an IP address. (During connection the control may attempt to connect to multiple IP addresses.) A related property is OverallConnectionTimeout, which specifies the maximum time for all attempts. |
| put_KeyboardType get_KeyboardType |
Valid for Windows CE only. Returns E_NOTIMPL on other operating systems. |
| put_KeyboardSubType get_KeyboardSubType |
Valid for Windows CE only. Returns E_NOTIMPL on other operating systems. |
| put_KeyboardFunctionKey get_KeyboardFunctionKey |
Valid for Windows CE only. Returns E_NOTIMPL on other operating systems. |
| put_WinCEFixedPalette get_WinCEFixedPalette |
Valid for Windows CE only. Returns E_NOTIMPL on other operating systems. |
| put_ConnectToServerConsole get_ConnectToServerConsole |
Sets or retrieves the ConnectToServerConsole property value, which specifies whether 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 the control should attempt to connect to the console) is not supported. |
| put_BitmapPersistence get_BitmapPersistence |
Sets or retrieves the BitmapPersistence property value, a LONG value that specifies whether persistent bitmap caching should be used. Persistent caching can improve performance but requires additional disk space. |
| put_MinutesToIdleTimeout get_MinutesToIdleTimeout |
Sets or retrieves the MinutesToIdleTimeout property value, which 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 IMsTscAxEvents::OnIdleTimeoutNotification. The default value is zero, which disables MinutesToIdleTimeout. You can use this property in a situation where you need to disconnect an idle session, such as a kiosk environment. |
| put_SmartSizing get_SmartSizing |
Sets or retrieves the SmartSizing property value, which specifies whether the display should be scaled to fit the client area of the control. VARIANT_TRUE enables scaling. Scroll bars do not appear when SmartSizing is enabled.
This property can be set when the control is connected. |
| put_RdpdrLocalPrintingDocName get_RdpdrLocalPrintingDocName |
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. |
| put_RdpdrClipCleanTempDirString get_RdpdrClipCleanTempDirString |
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. |
| put_RdpdrClipPasteInfoString get_RdpdrClipPasteInfoString |
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. |
| put_ClearTextPassword | Sets the value of the ClearTextPassword property, which specifies the password with which to connect. For more information, see IMsTscNonScriptable. This property is write-only. |
| put_DisplayConnectionBar get_DisplayConnectionBar |
Sets or retrieves the DisplayConnectionBar property value, which specifies whether to use the connection bar. The default value is VARIANT_TRUE, which enables the property. |
| put_PinConnectionBar get_PinConnectionBar |
Sets or retrieves the PinConnectionBar property value, which 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. |
| put_GrabFocusOnConnect get_GrabFocusOnConnect |
Sets or retrieves the GrabFocusOnConnect property value, which specifies whether the client control should have the focus while connecting. Setting this property to VARIANT_FALSE prevents the control from grabbing focus when connecting. The control will not attempt to grab focus from a window running in a different process. |
| put_RedirectPrinters get_RedirectPrinters |
Sets or retrieves the RedirectPrinters property value, which specifies whether redirection of printers is allowed. Setting this property to VARIANT_TRUE allows redirection. |
| put_RedirectPorts get_RedirectPorts |
Sets or retrieves the RedirectPorts property value, which specifies whether redirection of local ports (for example, COM and LPT) is allowed. Setting this property to VARIANT_TRUE prompts the user at connection time to confirm redirection. |
| put_RedirectSmartCards get_RedirectSmartCards |
Sets or retrieves the RedirectSmartCards property value, which specifies whether redirection of smart cards is allowed. Setting this property to VARIANT_TRUE prompts the user at connection time to confirm redirection. |
| put_BitmapVirtualCache16BppSize get_BitmapVirtualCache16BppSize |
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 bits per pixel high-color settings. The default value is 20KB. The maximum size for all virtual cache files is 128KB. Related properties include BitmapVirtualCacheSize and BitmapVirtualCache24BppSize. |
| put_BitmapVirtualCache24BppSize get_BitmapVirtualCache24BppSize |
Sets or retrieves the BitmapVirtualCache24BppSize property value, which specifies the size, in KB, of the persistent bitmap cache file to use for the 24 bits per pixel high-color setting. The default value is 30 KB. The maximum size for all virtual cache files is 128KB. Related properties include BitmapVirtualCacheSize and BitmapVirtualCache16BppSize. |
| put_PerformanceFlags get_PerformanceFlags |
Sets or retrieves the PerformanceFlags property value, which is a flag set specifying user preferences that can be set at the server to improve performance. The default value is zero (TS_PERF_DISABLE_NOTHING 0x00000000). For more information about the user preferences that can be set, see Terminal Services Client Configuration through the .rdp File |
| put_ConnectWithEndpoint | Reserved. This method returns E_NOTIMPL. |
Requirements
OS Versions: Windows CE .NET 4.0 and later.
Header: Discodlg.h. Mstsax.idl.
Link Library: Mstsax.lib.
See Also
Remote Desktop ActiveX Control Interface
Send Feedback on this topic to the authors