TscSettingsRead
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
Applies to Windows Embedded CE 6.0 R2 Update KB945975
This callback function retrieves a current value from the settings store that is implemented in cetsc.exe.
Cetsc.exe passes a reference to this callback function when it calls Initialize so that the OEM can use this function.
Syntax
HRESULT TscSettingsRead (
UINT uID,
LPVOID val
);
Parameters
- uID
[in] ID of the setting that you want to retrieve. For a list of the possible values, see the Remarks section.
- val
[in] A pointer to receive the value of the setting specified in uID. String buffers must be null-terminated.
Return Value
Returns standard HRESULT values.
Remarks
The OEM can choose the preferred way to call this function in the source code.
When this function is used to read a setting, it assumes that the read buffer is valid only for the duration of the UI and that it is read-only.
To retrieve a setting on the Display property page, the uID parameter can be one of the following values:
| ID | RDP setting |
|---|---|
OEMS_DESKTOP_WIDTH |
Desktop Width |
OEMS_DESKTOP_HEIGHT |
Desktop Height |
OEMS_START_FULL_SCREEN |
Whether the screen will start in full screen mode |
OEMS_SPAN_MONITORS |
Whether the screen will span multiple monditors |
OEMS_COLOR_DEPTH |
Color Depth BPP |
OEMS_DISPLAY_BBAR |
Whether RDP will show the connection bar |
OEMS_FULL_SCREEN_ALWAYS |
Whether the screen will always stay in full screen mode |
To retrieve a setting on the Local Resource property page, the uID parameter can be one of the following values:
| ID | RDP setting |
|---|---|
OEMS_KEYBD_HOOK_MODE |
Keyboard Hook Mode |
OEMS_REDIR_SND_MODE |
Sound Redirection Mode |
OEMS_REDIR_DRIVE |
Whether Legacy Drive Redirection is enabled |
OEMS_REDIR_PRINTER |
Whether Printer Redirection is enabled |
OEMS_REDIR_PORT |
Whether COM Port Redirection is enabled |
OEMS_REDIR_CLIPBOARD |
Whether Clipboard Redirection is enabled |
OEMS_STORE_DRIVES |
OEM Store Drive |
OEMS_REDIR_SCARD |
Whether Smart Card Redirection is enabled |
OEMS_CAN_REDIR_PRINTER |
Whether the printer can be redirected |
OEMS_CAN_REDIR_CLIPBOARD |
Whether the Clipboard can be redirected |
OEMS_REDIR_COMPONENTS |
Number of redirected components |
To retrieve a setting on the Programs property page, the uID parameter can be one of the following values:
| ID | RDP setting |
|---|---|
OEMS_START_PROGRAMS |
Whether a start-up program is enabled |
OEMS_ALTERNATE_SHELL |
Alternative Shell Name |
OEMS_WORKING_DIR |
Working Directory Name |
To retrieve a setting on the Experience property page, the uID parameter can be one of the following values:
| ID | RDP setting |
|---|---|
OEMS_PERF_FLAGS |
Performance Flags |
OEMS_AUTO_RECONNECT |
Whether Auto Reconnection is enabled |
To retrieve a setting on the Advanced property page, the uID parameter can be one of the following values:
| ID | RDP setting |
|---|---|
OEMS_AUTH_LEVEL |
Authentication Level |
OEMS_AUTHLV_OVERRIDE |
Authentication Level Override |
OEMS_AUTHLV_OVERRIDE_EXISTS |
Whether Authentication Level Override Exists |
OEMS_CREDSSP_SUPPORT |
Whether CredSSP Support is enabled |
Requirements
| Header | oem_settings.h |
| Windows Embedded CE | Windows Embedded CE 6.0 R2 |