Terminal Services Client Configuration through the .rdp File
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
When an operating system that contains Remote Desktop Protocol (RDP) is deployed and run on a Remote Desktop device, a default file with the extension .rdp is created that contains user preferences. Additionally, when using a shell other than the Thin Client Shell, these preferences can be applied during the RDP session. You can edit this file by using the Windows Embedded CE Terminal Services Client (CETSC) user interface, or by using a text editor such as Notepad.
Note
If the Windows Thin Client Shell is used, these settings are saved in the registry rather than in an .rdp file. For more information, see Configuring the Terminal Services Client.
Settings for the .rdp File
The following table shows the valid keywords, types, and sample values for the .rdp file. Valid types are "s" for string and "i" for integer.
| Keyword:type | Default value | Description |
|---|---|---|
alternate shell:s |
" " |
Determines whether a program is started automatically when you connect with RDP. This setting corresponds to the Program path and file name box on the Programs tab of the Remote Desktop Connection client. To specify an alternate shell, the value is a valid path to an executable file, for example, "C:\ProgramFiles\Office\word.exe". This setting also determines the path or the alias of the Remote Application to be started at connection time if RemoteApplicationMode is enabled. |
audioMode:i |
0 |
Indicates where the audio plays. This setting corresponds to the Remote computer sound box on the Local Resources tab of Remote Desktop Connection client. A value of zero (0) indicates that the audio plays on the host server. A value of 1 indicates that the audio plays on the Remote Desktop device. A value of 2 indicates that the audio does not play. |
authentication level:i |
2 |
Defines the server authentication level settings. A value of 0 indicates none. A value of 1 indicates that server authentication is required. A value of 2 indicates that server authentication is negotiable. A value of 3 indicates that server authentication is unspecified. |
autoReconnectionEnabled:i |
1 |
Indicates whether an attempt is made to automatically reconnect to the host if a connection is lost. A value of 1 indicates that the client computer automatically tries to reconnect. A value of zero (0) indicates that the Remote Desktop device automatically tries to reconnect. |
bitmapCacheSize:i |
1500 |
Specifies the size, in KB, of the bitmap cache in memory. The maximum value is 32000. |
bitmapPersistCacheLocation:s |
\Temp |
Indicates the location of the bitmap cache. |
compression:i |
1 |
Enables file and directory compression. Compression is on by default and it is recommended that it remain so. |
connect to console:i |
0 |
Used only in non-Windows-based Thin Client configurations. It enables the console to connect to from the command line. A value of zero (0) indicates that the command connects to a Terminal Services session. A value of 1 indicates that the command connects to the host console session. Windows XP Professional ignores this setting. |
desktopheight:i |
0 |
Indicates the height of the display, in pixels. The default value is the resolution that the operating system uses when it starts up. This value can range from 200 to 2048 pixels. |
desktopwidth:i |
0 |
Indicates the width of the display, in pixels. The default value is the resolution that the operating system uses when it starts up. This value can range from 200 to 4096 pixels. |
disable cursor setting:i |
0 |
Indicates whether cursor blinking is enabled during a Terminal Services session. A value of 1 indicates that cursor blinking is not available. A value of 0 indicates that cursor blinking is enabled. |
disable full window drag:i |
1 |
Indicates whether the contents of a graphical window are visible while the user drags it in a Terminal Services session. A value of 1 indicates that the contents of the window do not appear while the user drags it. A value of zero (0) indicates that the contents of the window do appear while the user drags it. This setting corresponds to the Show contents of window while dragging box on the Experience tab of the Remote Desktop Connection client. |
disable menu anims:i: |
1 |
Indicates whether menu and window animations are enabled or disabled. A value of 1 indicates that animations are not permitted. A value of zero (0) indicates that animations are allowed. This setting corresponds to the Menu and window animation box on the Experience tab of the Remote Desktop Connection client. |
disable themes:i |
0 |
Indicates whether themes are permitted when you log on to a remote server. A value of zero (0) indicates that themes are permitted. A value of 1 indicates that themes are not available. This setting corresponds to the Themes box on the Experience tab of the Remote Desktop Connection client. |
disable wallpaper:i |
1 |
Indicates whether wallpaper is disabled or enabled. A value of 1 indicates that wallpaper is enabled. A value of zero (0) indicates that wallpaper is not available. This setting corresponds to the Desktop background box on the Experience tab of the Remote Desktop Connection client. |
displayconnectionbar:i |
1 |
Indicates whether the connection bar is displayed on the remote desktop when in full screen mode. This setting corresponds to the selection in the Display the connection bar when in full screen mode box on the Display tab of the Remote Desktop Connection client. |
EnableCredSspSupport:1 |
1 |
Enables support for CredSSP, if it is present on the Remote Desktop device. A value of 0 indicates that CredSSP support is off, and a value of 1 indicates that it is on. |
keyboardhook:i |
2 |
Indicates whether Windows key combinations are applied. A value of zero (0) indicates that Windows key combinations are applied locally on the Remote Desktop device. A value of 1 indicates that they are applied on the remote server. A value of 2 indicates that they are applied in full-screen mode only. This setting corresponds to the selection in the Keyboard box on the Local Resources tab of the Remote Desktop Connection client. |
redirectclipboard:i |
1 |
Indicates whether the clipboard will be automatically redirected during a Terminal Services session. A value of 0 indicates that clipboard redirection is not available. A value of 1 indicates that clipboard redirection is enabled. |
redirectdrives:i |
0 |
Indicates whether disk drives are automatically redirected when you log on to a remote server. A value of 1 indicates that drive redirection is on. A value of zero (0) indicates that drive redirection is off. This setting corresponds to the Disk Drives box on the Local Resources tab of Remote Desktop Connection client. |
redirectcomports:i |
0 |
Indicates whether COM ports are automatically redirected when you connect to a remote server. A value of 1 indicates that COM port redirection is on. A value of zero (0) indicates that COM port redirection is off. This setting corresponds to the Serial Ports box on the Local Resources tab of the Remote Desktop Connection client. |
redirectprinters:i |
1 |
Indicates whether printers are automatically redirected when you log on to a remote server. A value of 1 indicates that printer redirection is on, and a value of zero (0) indicates that it is off. This setting corresponds to the Printers box on the Local Resources tab of Remote Desktop Connection client. |
redirectsmartcards:i |
1 |
Specifies whether redirection of Smart Cards is permitted during server authentication. A value of 1 indicates that redirection of Smart Cards is on. A value of zero (0) indicates that redirection of Smart Cards is off. This setting corresponds to the Smart cards box on the Local Resources tab of Remote Desktop Connection client. |
Screen Mode Id:i |
0 |
Indicates whether the remote desktop will be displayed in full-screen mode or normal mode. A value of 0 indicates full-screen mode. A value of 1 indicates window mode. |
session bpp:i |
Defaults to the bit depth of the local system |
Defines the bits-per-pixel (bpp) depth for a session. It can be one of the following:
This setting corresponds to the color depth that you select in Colors on the Display tab of the Remote Desktop Connection client. |
shell working directory:s |
" " |
If an alternate shell was specified, this value indicates a valid path to the folder in which the application that is started up automatically is located. This setting corresponds to the Program path and file name box on the Programs tab of the Remote Desktop Connection client. |
Span Monitors:i |
0 |
Enables monitor spanning. A value of 0 indicates monitor spanning is not available. A value of 1 indicates that monitor spanning is enabled. |
You can associate an .rdp file with CETSC through the registry. The following example shows how to make this association in rdp.reg.
[HKEY_CLASSES_ROOT\.rdp]
@="rdpfile"
[HKEY_CLASSES_ROOT\rdpfile]
@=LOC_RDPCONNECTION
[HKEY_CLASSES_ROOT\rdpfile\DefaultIcon]
@="\\Windows\\cetsc.exe,-101"
[HKEY_CLASSES_ROOT\rdpfile\Shell\Open\Command]
@="\\Windows\\cetsc.exe %1"
See Also
Concepts
Terminal Services Programming Guidelines
RDP Registry Settings