SysParamInfo

Retrieves or sets the value of one of the system-wide parameters.

Syntax:

SysParamInfo( request, value, ini-update)

Parameters:

(i) request: Specifies the system-wide parameter to retrieve or set.

(s/i) value: Depends on specified request. (see below)

(i) ini-update: Ignored when retrieving information When setting values this parameter determines to what extent the value gets updated:
Value
 Meaning
0 Set system value in memory only for future reference
1 Write new value to appropriate INI file
2 Broadcast message to all applications informing them of new value
3 Both 1 and 2

Returns:

(s/i) Depends on specified request. (see below). Note: If this function is unable to execute for any reason, it returns the string "*UNSUPPORTED*"

 

Request

Name

Meaning

50

GetFilterKeys

Retrieves information about the FilterKeys accessibility feature.

Value:
(N/A).

Returns:
(s) <FILTERKEYS> format string (see below).

51

SetFilterKeys

Sets the parameters of the FilterKeys accessibility feature.

Value:
(s) <FILTERKEYS> format string (see below).

Returns:
(s) "".

52

GetToggleKeys

Retrieves information about the ToggleKeys accessibility feature.

Value:
(N/A).

Returns:
(s) <TOGGLEKEYS> format string (see below).

53

SetToggleKeys

Sets the parameters of the ToggleKeys accessibility feature.

Value:
(s) <TOGGLEKEYS> format string (see below).

Returns:
(s) "".

54

GetMouseKeys

Retrieves information about the MouseKeys accessibility feature.

Value:
(N/A).

Returns:
(s) <MOUSEKEYS> format string (see below).

55

SetMouseKeys

Sets the parameters of the MouseKeys accessibility feature.

Value:
(s) <MOUSEKEYS> format string (see below).

Returns:
(s) "".

56

GetShowSounds

Determines whether the Show Sounds accessibility flag is on or off. If it is on, the user requires an application to present information visually in situations where it would otherwise present the information only in audible form. Using this value is equivalent to calling WinMetrics(70). That is the recommended call.

Value:
(N/A).

Returns:
(i)
@TRUE if the feature is on, or @FALSE if it is off.

57

SetShowSounds

Sets the ShowSounds accessibility feature as on or off.

Value:
(i)
@TRUE for on, or @FALSE for off.

Returns:
(s) "".

58

GetStickyKeys

Retrieves information about the StickyKeys accessibility feature.

Value:
(N/A).

Returns:
(s) <STICKYKEYS > format string (see below).

59

SetStickyKeys

Sets the parameters of the StickyKeys accessibility feature.

Value:
(s) <STICKYKEYS> format string (see below).

Returns:
(s) "".

60

GetAccessTimeout

Retrieves information about the time-out period associated with the accessibility features.

Value:
(N/A).

Returns:
(s) <ACCESSTIMEOUT> format string (see below).

61

SetAccessTimeout

Sets the time-out period associated with the accessibility features.

Value:
(s) <ACCESSTIMEOUT> format string (see below).

Returns:
(s) "".

62

GetSerialKeys

Windows NT/2000/XP: Not supported.

Value:
(N/A).

Returns:
(s) <SERIALKEYS> format string (see below).

63

SetSerialKeys

Sets the parameters of the SerialKeys accessibility feature.

Value:
(s) <SERIALKEYS> format string (see below).

Returns:
(s) "".

64

GetSoundSentry

Retrieves information about the SoundSentry accessibility feature.

Value:
(N/A).

Returns:
(s) <SOUNDSENTRY> format string (see below).

65

SetSoundSentry

Sets the parameters of the SoundSentry accessibility feature.

Value:
(s) <SOUNDSENTRY> format string (see below).

Returns:
(s) "".

66

GetHighContrast

Windows 2000/XP: Retrieves information about the HighContrast accessibility feature.

Value:
(N/A).

Returns:
(s) <HIGHCONTRAST> format string (see below).

67

SetHighContrast

Windows 2000/XP: Sets the parameters of the HighContrast accessibility feature.

Value:
(s) <HIGHCONTRAST> format string (see below).

Returns:
(s) "".

70

GetScreenReader

Windows 2000/XP: Determines whether a screen reviewer utility is running. A screen reviewer utility directs textual information to an output device, such as a speech synthesizer or Braille display. When this flag is set, an application should provide textual information in situations where it would otherwise present the information graphically.

Value:
(N/A).

Returns:
(i)
@TRUE if a screen reviewer utility is running, or @FALSE otherwise.

71

SetScreenReader

Windows 2000/XP: Indicates whether a screen review utility is running.

Value:
(i)
@TRUE for on, or @FALSE for off.

Returns:
(s) "".

4124

GetMouseSonar

Windows Me, Windows XP: Gets the state of the Mouse Sonar feature.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled or @FALSE otherwise.

4125

SetMouseSonar

Windows Me, Windows XP: Turns the Sonar accessibility feature on or off. This feature briefly shows several concentric circles around the mouse pointer when the user presses and releases the CTRL key.

Value:
(i)
@TRUE for on and @FALSE for off. The default is off.

Returns:
(s) "".

4126

GetMouseClickLock

Windows Me, Windows XP: Gets the state of the Mouse ClickLock feature.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled, or @FALSE otherwise.

4127

SetMouseClickLock

Windows Me, Windows XP: Turns the Mouse ClickLock accessibility feature on or off. This feature temporarily locks down the primary mouse button when that button is clicked and held down for the time specified by SetMouseClickLockTime (request #8201).

Value:
(i)
@TRUE for on, or @FALSE for off. The default is off.

Returns:
(s) "".

4128

GetMouseVanish

Windows Me, Windows XP: Gets the state of the Mouse Vanish feature.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled or @FALSE otherwise.

4129

SetMouseVanish

Windows Me, Windows XP: Turns the Vanish feature on or off. This feature hides the mouse pointer when the user types; the pointer reappears when the user moves the mouse.

Value:
(i)
@TRUE for on and @FALSE for off.

Returns:
(s) "".

8200

GetMouseClickLockTime

Windows Me, Windows XP: Gets the time delay before the primary mouse button is locked. This is only enabled if SetMouseClickLock (request #4127) is set to @TRUE.

Value:
(N/A).

Returns:
(i).

8201

SetMouseClickLockTime

Windows Me, Windows XP: Adjusts the time delay before the primary mouse button is locked.

Value:
(i) time delay in microseconds. For example, specify 1000 for a 1 second delay. The default is 1200.

Returns:
(s) "".

8206

GetFocusBorderWidth

Windows XP: Gets the width, in pixels, of the left and right edges of the focus rectangle drawn with DrawFocusRect.

Value:
(N/A).

Returns:
(i).

8207

SetFocusBorderWidth

Windows XP: Sets the height of the left and right edges of the focus rectangle drawn with DrawFocusRect.

Value:
(i).

Returns:
(s) "".

8208

GetFocusBorderHeight

Windows XP: Gets the height, in pixels, of the top and bottom edges of the focus rectangle drawn with DrawFocusRect.

Value:
(N/A).

Returns:
(i).

8209

SetFocusBorderHeight

Windows XP: Sets the height of the top and bottom edges of the focus rectangle drawn with DrawFocusRect.

Value:
(i).

Returns:
(s) "".

 

Desktop

 

20

SetDeskWallpaper

Sets the desktop wallpaper.

Value:
(s) the name of a graphic file to be used for the wallpaper, or "" to remove the wallpaper, or "*DEFAULT*" to revert to the default wallpaper.

Windows Server 2003 and XP/2000: cannot specify a .jpg file.

Returns:
(s) "".

21

SetDeskPattern

Sets the current desktop pattern by causing Windows to read the Pattern= setting from the WIN.INI file.

Value:
(N/A).

Returns:
(s) "".

47

SetWorkArea

Sets the size of the work area. The work area is the portion of the screen not obscured by the system taskbar or by application desktop toolbars. In a system with multiple display monitors, the function sets the work area of the monitor that contains the specified rectangle.

Value:
(s) comma-delimited coordinates of the work area, expressed in virtual screen pixel coordinates, in the format: "left,top,right,bottom"; or "" to set the work area of the primary display monitor to the full screen.

Returns:
(s) "".

48

GetWorkArea

Retrieves the size of the work area on the primary display monitor. The work area is the portion of the screen not obscured by the system taskbar or by application desktop toolbars.

Value:
(N/A).

Returns:
(s) comma-delimited coordinates of the work area, expressed in virtual screen pixel coordinates, in the format: "left,top,right,bottom".

74

GetFontSmoothing

Indicates whether the font smoothing feature is enabled. This feature uses font antialiasing to make font curves appear smoother by painting pixels at different gray levels.

Value:
(N/A).

Returns:
(i)
@TRUE if the feature is enabled, or @FALSE if it is not.

75

SetFontSmoothing

Enables or disables the font smoothing feature, which uses font antialiasing to make font curves appear smoother by painting pixels at different gray levels.

Value:
(i)
@TRUE to enable the feature, or @FALSE to disable the feature.

Returns:
(s) "".

87

SetCursors

Reloads the system cursors.

Value:
(N/A).

Returns:
(s) "".

115

GetDeskWallpaper

Windows 2000/XP: Retrieves the filename of the graphic file for the desktop wallpaper. If there is no desktop wallpaper, the returned string is empty.

Value:
(N/A).

Returns:
(s).

4130

GetFlatMenu

Windows XP: Indicates whether native User menus have flat menu appearance.

Value:
(N/A).

Returns:
(i)
@TRUE if the flat menu appearance is set, or @FALSE otherwise.

4131

SetFlatMenu

Windows XP: Enables or disables flat menu appearance for native User menus. When enabled, the menu bar uses COLOR_MENUBAR for the menubar background, COLOR_MENU for the menu-popup background, COLOR_MENUHILIGHT for the fill of the current menu selection, and COLOR_HILIGHT for the outline of the current menu selection. If disabled, menus are drawn using the same metrics and colors as in Windows 2000 and earlier.

Value:
(i)
@TRUE to enable flat menu appearance or @FALSE to disable it.

Returns:
(s) "".

4132

GetDropShadow

Windows XP: Indicates whether the drop shadow effect is enabled.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled or @FALSE if disabled.

4133

SetDropShadow

Windows XP: Enables or disables the drop shadow effect. You must also have CS_DROPSHADOW in the window class style.

Value:
(i)
@TRUE to enable the drop shadow effect or @FALSE to disable it.

Returns:
(s) "".

8202

GetFontSmoothingType

Windows XP: Returns the type of font smoothing.

Value:
(N/A).

Returns:
(i).

8203

SetFontSmoothingType

Windows XP: Changes the font smoothing type. SetFontSmoothing (request #75) must also be set.

Value:
(i) 1, if standard anti-aliasing is used, or 2, if ClearType is used. The default is 1.

Returns:
(s) "".

8204

GetFontSmoothingContrast

Windows XP: Returns a contrast value that is used in ClearType™ smoothing.

Value:
(N/A).

Returns:
(i).

8205

SetFontSmoothingContrast

Windows XP: Changes the contrast value used in ClearType smoothing. SetFontSmoothingType (request #8203) must also be set to 2.

Value:
(i) contrast value, from 1000 to 2200. The default value is 1400.

Returns:
(s) "".

 

Icon

 

13

IconHorizontalSpacing

Sets or retrieves the width, in pixels, of an icon cell. The system uses this rectangle to arrange icons in large icon view. You cannot set this value to less than WinMetrics(11).

Value:
(i).

Returns:
(i).

24

IconVerticalSpacing

Sets or retrieves the height, in pixels, of an icon cell. You cannot set this value to less than WinMetrics(12).

Value:
(i).

Returns:
(i).

25

GetIconTitleWrap

Determines whether icon-title wrapping is enabled.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled, or @FALSE otherwise.

26

SetIconTitleWrap

Turns icon-title wrapping on or off.

Value:
(i)
@TRUE for on, or @FALSE for off..

Returns:
(s) "".

31

GetIconTitleLogFont

Retrieves the logical font information for the current icon-title font.

Value:
(N/A).

Returns:
(s) <LOGFONT> format string (see below).

34

SetIconTitleLogFont

Sets the font that is used for icon titles.

Value:
(s) <LOGFONT> format string (see below).

Returns:
(s) "".

45

GetIconMetrics

Retrieves the metrics associated with icons.

Value:
(N/A).

Returns:
(s) <ICONMETRICS> format string (see below).

46

SetIconMetrics

Sets the metrics associated with icons.

Value:
(s) <ICONMETRICS> format string (see below).

Returns:
(s) "".

88

SetIcons

Reloads the system icons.

Value:
(N/A).

Returns:
(s) "".

 

Input

 

1

GetBeep

Indicates whether the warning beeper is on.

Value:
(N/A).

Returns:
(i)
@TRUE if the beeper is on, or @FALSE if it is off.

2

SetBeep

Turns the warning beeper on or off.

Value:
(i)
@TRUE for on, or @FALSE for off.

Returns:
(s) "".

3

GetMouse

Retrieves the two mouse threshold values and the mouse acceleration.

Value:
(N/A).

Returns:
(s) comma-delimited string in the format: "threshold-1,threshold-2,acceleration".

4

SetMouse

Sets the two mouse threshold values and the mouse acceleration.

Value:
(s) comma-delimited string in the format: "threshold-1,threshold-2,acceleration".

Returns:
(s) "".

10

GetKeyboardSpeed

Retrieves the keyboard repeat-speed setting, which is a value in the range from 0 (approximately 2.5 repetitions per second) through 31 (approximately 30 repetitions per second). The actual repeat rates are hardware-dependent and may vary from a linear scale by as much as 20%.

Value:
(N/A).

Returns:
(i).

11

SetKeyboardSpeed

Sets the keyboard repeat-speed setting.

Value:
(i) a value in the range from 0 (approximately 2.5 repetitions per second) through 31 (approximately 30 repetitions per second). The actual repeat rates are hardware-dependent and may vary from a linear scale by as much as 20%. If "value" is greater than 31, the parameter is set to 31..

Returns:
(s) "".

22

GetKeyboardDelay

Retrieves the keyboard repeat-delay setting, which is a value in the range from 0 (approximately 250 ms delay) through 3 (approximately 1 second delay). The actual delay associated with each value may vary depending on the hardware.

Value:
(N/A).

Returns:
(i).

23

SetKeyboardDelay

Sets the keyboard repeat-delay setting.

Value:
(i) 0, 1, 2, or 3, where zero sets the shortest delay (approximately 250 ms) and 3 sets the longest delay (approximately 1 second). The actual delay associated with each value may vary depending on the hardware..

Returns:
(s) "".

29

SetDoubleClkWidth

Sets the width of the double-click rectangle. The double-click rectangle is the rectangle within which the second click of a double-click must fall for it to be registered as a double-click. To retrieve the width of the double-click rectangle, call WinMetrics(36).

Value:
(i).

Returns:
(s) "".

30

SetDoubleClkHeight

Sets the height of the double-click rectangle. The double-click rectangle is the rectangle within which the second click of a double-click must fall for it to be registered as a double-click. To retrieve the height of the double-click rectangle, call WinMetrics(37).

Value:
(i).

Returns:
(s) "".

32

SetDoubleClickTime

Sets the double-click time for the mouse. The double-click time is the maximum number of milliseconds that can occur between the first and second clicks of a double-click.

Value:
(i).

Returns:
(s) "".

33

SetMouseButtonSwap

Swaps or restores the meaning of the left and right mouse buttons.

Value:
(i)
@TRUE to swap the meanings of the buttons, or @FALSE to restore their original meanings..

Returns:
(s) "".

68

GetKeyboardPref

Windows 2000/XP: Determines whether the user relies on the keyboard instead of the mouse, and wants applications to display keyboard interfaces that would otherwise be hidden.

Value:
(N/A).

Returns:
(i)
@TRUE if the user relies on the keyboard; or @FALSE otherwise.

69

SetKeyboardPref

Windows 2000/XP: Sets the keyboard preference.

Value:
(i)
@TRUE if the user relies on the keyboard instead of the mouse, and wants applications to display keyboard interfaces that would otherwise be hidden; @FALSE otherwise..

Returns:
(s) "".

89

GetDefaultInputLang

Returns the input locale identifier for the system default input language.

Value:
(N/A).

Returns:
(i) HKL variable.

90

SetDefaultInputLang

Sets the default input language for the system shell and applications. The specified language must be displayable using the current system character set.

Value:
(i) HKL variable that contains the input locale identifier for the default language.

Returns:
(s) "".

91

SetLangToggle

Sets the hot key set for switching between input languages. The value sets the shortcut keys in the keyboard property sheets by reading the registry again. The registry must be set before this flag is used. the path in the registry is \HKEY_CURRENT_USER\keyboard layout\toggle. Valid values are "1" = ALT+SHIFT, "2" = CTRL+SHIFT, and "3" = none.

Value:
(N/A).

Returns:
(s) "".

93

SetMouseTrails

Windows XP: Enables or disables the Mouse Trails feature, which improves the visibility of mouse cursor movements by briefly showing a trail of cursors and quickly erasing them.

Value:
(i) to disable the feature, set "value" to zero or 1. To enable the feature, set "value" to a value greater than 1 to indicate the number of cursors drawn in the trail.

Returns:
(s) "".

94

GetMouseTrails

Windows XP: Indicates whether the Mouse Trails feature is enabled. This feature improves the visibility of mouse cursor movements by briefly showing a trail of cursors and quickly erasing them. If the value is zero or 1, the feature is disabled. If the value is greater than 1, the feature is enabled and the value indicates the number of cursors drawn in the trail.

Value:
(N/A).

Returns:
(i).

95

GetSnapToDefButton

Determines whether the snap-to-default-button feature is enabled. If enabled, the mouse cursor automatically moves to the default button, such as OK or Apply, of a dialog box.

Value:
(N/A).

Returns:
(i)
@TRUE if the feature is on, or @FALSE if it is off.

96

SetSnapToDefButton

Enables or disables the snap-to-default-button feature. If enabled, the mouse cursor automatically moves to the default button, such as OK or Apply, of a dialog box.

Value:
(i)
@TRUE to enable the feature, or @FALSE to disable it.

Returns:
(s) "".

98

GetMouseHoverWidth

Gets the width, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message.

Value:
(N/A).

Returns:
(i) width.

99

SetMouseHoverWidth

Sets the width, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message.

Value:
(i).

Returns:
(s) "".

100

GetMouseHoverHeight

Gets the height, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message.

Value:
(N/A).

Returns:
(i) height.

101

SetMouseHoverHeight

Sets the height, in pixels, of the rectangle within which the mouse pointer has to stay for TrackMouseEvent to generate a WM_MOUSEHOVER message.

Value:
(i).

Returns:
(s) "".

102

GetMouseHoverTime

Gets the time, in milliseconds, that the mouse pointer has to stay in the hover rectangle for TrackMouseEvent to generate a WM_MOUSEHOVER message.

Value:
(N/A).

Returns:
(i) time.

103

SetMouseHoverTime

Sets the time, in milliseconds, that the mouse pointer has to stay in the hover rectangle for TrackMouseEvent to generate a WM_MOUSEHOVER message. This is used only if you pass HOVER_DEFAULT in the dwHoverTime parameter in the call to TrackMouseEvent.

Value:
(i).

Returns:
(s) "".

104

GetWheelScrollLines

Gets the number of lines to scroll when the mouse wheel is rotated. The default value is 3.

Value:
(N/A).

Returns:
(i) number of lines.

105

SetWheelScrollLines

Sets the number of lines to scroll when the mouse wheel is rotated. The number of lines is the suggested number of lines to scroll when the mouse wheel is rolled without using modifier keys. If the number is 0, then no scrolling should occur. If the number of lines to scroll is greater than the number of lines viewable, and in particular if it is -1, the scroll operation should be interpreted as clicking once in the page down or page up regions of the scroll bar.

Value:
(i).

Returns:
(s) "".

112

GetMouseSpeed

Windows 2000/XP: Retrieves the current mouse speed. The mouse speed determines how far the pointer will move based on the distance the mouse moves. It is a value which ranges between 1 (slowest) and 20 (fastest). A value of 10 is the default. The value can be set by an end user using the mouse control panel application or by an application using SetMouseSpeed (request #113).

Value:
(N/A).

Returns:
(i).

113

SetMouseSpeed

Windows 2000/XP: Sets the current mouse speed. This value is typically set using the mouse control panel application.

Value:
(i) an integer between 1 (slowest) and 20 (fastest). A value of 10 is the default.

Returns:
(s) "".

4106

GetKeyboardCues

Windows 2000/XP: Indicates whether menu access keys are always underlined.

Value:
(N/A).

Returns:
@TRUE
if menu access keys are always underlined, and @FALSE if they are underlined only when the menu is activated by the keyboard.

4107

SetKeyboardCues

Windows 2000/XP: Sets the underlining of menu access key letters.

Value:
(i)
@TRUE to always underline menu access keys, or @FALSE to underline menu access keys only when the menu is activated from the keyboard.

Returns:
(s) "".

 

Menu

 

27

GetMenuDropAlignment

Determines whether pop-up menus are left-aligned or right-aligned, relative to the corresponding menu-bar item.

Value:
(N/A).

Returns:
(i)
@TRUE if left-aligned, or @FALSE otherwise.

28

SetMenuDropAlignment

Sets the alignment value of pop-up menus.

Value:
(i)
@TRUE for right alignment, or @FALSE for left alignment.

Returns:
(s) "".

106

GetMenuShowDelay

Indicates the time, in milliseconds, that the system waits before displaying a shortcut menu when the mouse cursor is over a submenu item.

Value:
(N/A).

Returns:
(i).

107

SetMenuShowDelay

Sets the time, in milliseconds, that the system waits before displaying a shortcut menu when the mouse cursor is over a submenu item.

Value:
(i).

Returns:
(s) "".

4114

GetMenuFade

Windows 2000/XP: Indicates whether menu fade animation is enabled. If fade animation is disabled, menus use slide animation. This flag is ignored unless menu animation is enabled, which you can do using the SetMenuAnimation (request #4099) flag.

Value:
(N/A).

Returns:
(i)
@TRUE when fade animation is enabled and @FALSE when it is disabled.

4115

SetMenuFade

Windows 2000/XP: Enables or disables menu fade animation. If fade animation is disabled, menus use slide animation. he The menu fade effect is possible only if the system has a color depth of more than 256 colors. This flag is ignored unless SetMenuAnimation (request #4099) is also set.

Value:
(i)
@TRUE to enable the menu fade effect or @FALSE to disable it.

Returns:
(s) "".

 

Power

 

79

GetLowPowerTimeout

Retrieves the time-out value for the low-power phase of screen saving. Windows 2000/XP: This flag is supported for 32-bit applications. It is not supported for 16-bit applications.

Value:
(N/A).

Returns:
(i).

80

GetPowerOffTimeout

Retrieves the time-out value for the power-off phase of screen saving. Windows 2000/XP: This flag is supported for 32-bit applications. It is not supported for 16-bit applications.

Value:
(N/A).

Returns:
(i).

81

SetLowPowerTimeout

Sets the time-out value, in seconds, for the low-power phase of screen saving. Windows 2000/XP: This flag is supported for 32-bit applications. It is not supported for 16-bit applications.

Value:
(i).

Returns:
(s) "".

82

SetPowerOffTimeout

Sets the time-out value, in seconds, for the power-off phase of screen saving. Windows 2000/XP: This flag is supported for 32-bit applications. It is not supported for 16-bit applications.

Value:
(i).

Returns:
(s) "".

83

GetLowPowerActive

Determines whether the low-power phase of screen saving is enabled. Windows 2000/XP: This flag is supported for 32-bit. It is not supported for 16-bit applications.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled, or @FALSE if disabled.

84

GetPowerOffActive

Determines whether the power-off phase of screen saving is enabled. Windows 2000/XP: This flag is supported for 32-bit applications. It is not supported for 16-bit applications.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled, or @FALSE if disabled.

85

SetLowPowerActive

Activates or deactivates the low-power phase of screen saving. Windows 2000/XP: This flag is supported for 32-bit applications. It is not supported for 16-bit applications.

Value:
(i) 1 to activate, or zero to deactivate.

Returns:
(s) "".

86

SetPowerOffActive

Activates or deactivates the power-off phase of screen saving. Windows 2000/XP: This flag is supported for 32-bit applications. It is not supported for 16-bit applications.

Value:
(i) 1 to activate, or zero to deactivate.

Returns:
(s) "".

 

Screen saver

 

14

GetScreenSaveTimeout

Retrieves the screen saver time-out value, in seconds.

Value:
(N/A).

Returns:
(i).

15

SetScreenSaveTimeout

Sets the screen saver time-out value. This value is the amount of time, in seconds, that the system must be idle before the screen saver activates.

Value:
(i).

Returns:
(s) "".

16

GetScreenSaveActive

Determines whether screen saving is enabled.

Value:
(N/A).

Returns:
(i)
@TRUE if screen saving is enabled, or @FALSE otherwise.

17

SetScreenSaveActive

Sets the state of the screen saver.

Value:
(i)
@TRUE to activate screen saving, or @FALSE to deactivate it.

Returns:
(s) "".

114

GetScreenSaverRunning

Windows 2000/XP: Determines whether a screen saver is currently running on the window station of the calling process. Note that only the interactive window station, "WinSta0", can have a screen saver running.

Value:
(N/A).

Returns:
(i)
@TRUE if a screen saver is currently running, or @FALSE otherwise.

 

UI effects

 

4098

GetMenuAnimation

Windows 2000/XP: Indicates whether the menu animation feature is enabled. This master switch must be on to enable menu animation effects. Windows 2000/XP: If animation is enabled, GetMenuFade (request #4114) indicates whether menus use fade or slide animation.

Value:
(N/A).

Returns:
(i)
@TRUE if animation is enabled and @FALSE if it is disabled.

4099

SetMenuAnimation

Windows 2000/XP: Enables or disables menu animation. This master switch must be on for any menu animation to occur. Windows 2000/XP: If animation is enabled, GetMenuFade (request #4114) indicates whether menus use fade or slide animation.

Value:
(i)
@TRUE to enable animation and @FALSE to disable animation.

Returns:
(s) "".

4100

GetComboBoxAnimation

Windows 2000/XP: Indicates whether the slide-open effect for combo boxes is enabled.

Value:
(N/A).

Returns:
(i)
@TRUE for enabled, or @FALSE for disabled.

4101

SetComboBoxAnimation

Windows 2000/XP: Enables or disables the slide-open effect for combo boxes.

Value:
(i)
@TRUE to enable the gradient effect, or @FALSE to disable it.

Returns:
(s) "".

4102

GetListBoxSmoothScrolling

Windows 2000/XP: Indicates whether the smooth-scrolling effect for list boxes is enabled.

Value:
(N/A).

Returns:
(i)
@TRUE for enabled, or @FALSE for disabled.

4103

SetListBoxSmoothScrolling

Windows 2000/XP: Enables or disables the smooth-scrolling effect for list boxes.

Value:
(i)
@TRUE to enable the smooth-scrolling effect, or @FALSE to disable it.

Returns:
(s) "".

4104

GetGradientCaptions

Windows 2000/XP: Indicates whether the gradient effect for window title bars is enabled.

Value:
(N/A).

Returns:
(i)
@TRUE for enabled, or @FALSE for disabled.

4105

SetGradientCaptions

Windows 2000/XP: Enables or disables the gradient effect for window title bars. The gradient effect is possible only if the system has a color depth of more than 256 colors.

Value:
(i)
@TRUE to enable the gradient effect, or @FALSE to disable it.

Returns:
(s) "".

4110

GetHotTracking

Windows 2000/XP: Indicates whether hot tracking of user-interface elements, such as menu names on menu bars, is enabled. Hot tracking means that when the cursor moves over an item, it is highlighted but not selected. You can query this value to decide whether to use hot tracking in the user interface of your application.

Value:
(N/A).

Returns:
(i)
@TRUE for enabled, or @FALSE for disabled.

4111

SetHotTracking

Windows 2000/XP: Enables or disables hot tracking of user-interface elements such as menu names on menu bars. Hot-tracking means that when the cursor moves over an item, it is highlighted but not selected.

Value:
(i)
@TRUE to enable hot tracking, or @FALSE to disable it.

Returns:
(s) "".

4116

GetSelectionFade

Windows 2000/XP: Indicates whether the selection fade effect is enabled. The selection fade effect causes the menu item selected by the user to remain on the screen briefly while fading out after the menu is dismissed.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled or @FALSE if disabled.

4117

SetSelectionFade

Windows 2000/XP: The selection fade effect causes the menu item selected by the user to remain on the screen briefly while fading out after the menu is dismissed. The selection fade effect is possible only if the system has a color depth of more than 256 colors.

Value:
(i)
@TRUE to enable the selection fade effect or @FALSE to disable it.

Returns:
(s) "".

4118

GetToolTipAnimation

Windows 2000/XP: Indicates whether ToolTip animation is enabled. If ToolTip animation is enabled, GetToolTipFade (request #4120) indicates whether ToolTips use fade or slide animation.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled or @FALSE if disabled.

4119

SetToolTipAnimation

Windows 2000/XP: Enables or disables ToolTip animation. If enabled, you can use SetToolTipFade (request #4121) to specify fade or slide animation.

Value:
(i)
@TRUE to enable ToolTip animation or @FALSE to disable it.

Returns:
(s) "".

4120

GetToolTipFade

Windows 2000/XP: If SetToolTipAnimation (request #4119) is enabled, this request indicates whether ToolTip animation uses a fade effect or a slide effect.

Value:
(N/A).

Returns:
(i)
@TRUE for fade animation or @FALSE for slide animation.

4121

SetToolTipFade

Windows 2000/XP: If the SetToolTipAnimation (request #4119) flag is enabled, use this request to indicate whether ToolTip animation uses a fade effect or a slide effect. The tooltip fade effect is possible only if the system has a color depth of more than 256 colors.

Value:
(i)
@TRUE for fade animation or @FALSE for slide animation.

Returns:
(s) "".

4122

GetCursorShadow

Windows 2000/XP: Indicates whether the cursor has a shadow around it. This effect appears only if the system has a color depth of more than 256 colors.

Value:
(N/A).

Returns:
(i)
@TRUE if the shadow is enabled, @FALSE if it is disabled.

4123

SetCursorShadow

Windows 2000/XP: Enables or disables a shadow around the cursor. This effect appears only if the system has a color depth of more than 256 colors.

Value:
(i)
@TRUE to enable the shadow or @FALSE to disable the shadow.

Returns:
(s) "".

4158

GetUiEffects

Windows 2000/XP: Indicates whether all UI effects are disabled or not.

Value:
(N/A).

Returns:
(i)
@TRUE if UI effects are enabled, or @FALSE if they are disabled.

4159

SetUiEffects

Windows 2000/XP: Enables or disables UI effects.

Value:
(i)
@TRUE to enable all UI effects or @FALSE to disable all UI effects.

Returns:
(s) "".

 

Window

 

5

GetBorder

Retrieves the border multiplier factor that determines the width of a window's sizing border.

Value:
(N/A).

Returns:
(i).

6

SetBorder

Sets the border multiplier factor that determines the width of a window's sizing border.

Value:
(i).

Returns:
(s) "".

37

SetDragFullWindows

Sets dragging of full windows either on or off.

Value:
(i)
@TRUE for on, or @FALSE for off.

Returns:
(s) "".

38

GetDragFullWindows

Determines whether dragging of full windows is enabled.

Value:
(N/A).

Returns:
(i)
@TRUE if enabled, or @FALSE otherwise.

41

GetNonClientMetrics

Retrieves the metrics associated with the nonclient area of nonminimized windows.

Value:
(N/A).

Returns:
(s) <NONCLIENTMETRICS> format string (see below).

42

SetNonClientMetrics

Sets the metrics associated with the nonclient area of nonminimized windows.

 

Note that the "Height" member of the <LOGFONT> item must be a negative value.

 

Value:
(s) <NONCLIENTMETRICS> format string (see below).

Returns:
(s) "".

43

GetMinimizedMetrics

Retrieves the metrics associated with minimized windows.

Value:
(N/A).

Returns:
(s) <MINIMIZEDMETRICS> format string (see below).

44

SetMinimizedMetrics

Sets the metrics associated with minimized windows.

Value:
(s) <MINIMIZEDMETRICS> format string (see below).

Returns:
(s) "".

72

GetAnimation

Retrieves the animation effects associated with user actions.

Value:
(N/A).

Returns:
(s) <ANIMATIONINFO> format string (see below).

73

SetAnimation

Sets the animation effects associated with user actions.

Value:
(s) <ANIMATIONINFO> format string (see below).

Returns:
(s) "".

76

SetDragWidth

Sets the width, in pixels, of the rectangle used to detect the start of a drag operation. To retrieve the drag width, call WinMetrics(68).

Value:
(i).

Returns:
(s) "".

77

SetDragHeight

Sets the height, in pixels, of the rectangle used to detect the start of a drag operation. To retrieve the drag height, call WinMetrics(69).

Value:
(i).

Returns:
(s) "".

110

GetShowImeUi

Windows 2000/XP: Indicates whether the IME status window is visible (on a per-user basis).

Value:
(N/A).

Returns:
(i)
@TRUE if the status window is visible, or @FALSE if it is not.

111

SetShowImeUi

Windows 2000/XP: Sets whether the IME status window is visible or not on a per-user basis.

Value:
(i)
@TRUE for on or @FALSE for off.

Returns:
(s) "".

4096

GetActiveWindowTracking

Windows 2000/XP: Indicates whether active window tracking (activating the window the mouse is on) is on or off.

Value:
(N/A).

Returns:
(i)
@TRUE for on, or @FALSE for off.

4097

SetActiveWindowTracking

Windows 2000/XP: Sets active window tracking (activating the window the mouse is on) either on or off.

Value:
(i)
@TRUE for on or @FALSE for off.

Returns:
(s) "".

4108

GetActiveWndTrkZorder

Windows 2000/XP: Indicates whether windows activated through active window tracking will be brought to the top.

Value:
(N/A).

Returns:
(i)
@TRUE for on, or @FALSE for off.

4109

SetActiveWndTrkZorder

Windows 2000/XP: Indicates whether or not windows activated through active window tracking should be brought to the top.

Value:
(i)
@TRUE for on or @FALSE for off.

Returns:
(s) "".

8192

GetForegroundLockTimeout

Windows 2000/XP: Indicates the amount of time following user input, in milliseconds, during which the system will not allow applications to force themselves into the foreground.

Value:
(N/A).

Returns:
(i).

8193

SetForegroundLockTimeout

Windows 2000/XP: Sets the amount of time following user input, in milliseconds, during which the system does not allow applications to force themselves into the foreground. Windows 2000/XP: The calling thread must be able to change the foreground window, otherwise the call fails.

Value:
(i).

Returns:
(s) "".

8194

GetActiveWndTrkTimeout

Windows 2000/XP: Indicates the active window tracking delay, in milliseconds.

Value:
(N/A).

Returns:
(i).

8195

SetActiveWndTrkTimeout

Windows 2000/XP: Sets the active window tracking delay.

Value:
(i) number of milliseconds to delay before activating the window under the mouse pointer.

Returns:
(s) "".

8196

GetForegroundFlashCount

Windows 2000/XP: Indicates the number of times SetForegroundWindow will flash the taskbar button when rejecting a foreground switch request.

Value:
(N/A).

Returns:
(i).

8197

SetForegroundFlashCount

Windows 2000/XP: Sets the number of times SetForegroundWindow will flash the taskbar button when rejecting a foreground switch request.

Value:
(i).

Returns:
(s) "".

8198

GetCaretWidth

Windows 2000/XP: Indicates the caret width in edit controls.

Value:
(N/A).

Returns:
(i) width of the caret in pixels.

8199

SetCaretWidth

Windows 2000/XP: Sets the caret width in edit controls.

Value:
(i) the desired width, in pixels. The default and minimum value is 1.

Returns:
(s) "".

 

Misc

 

49

SetPenWindows

Specifies that pen windows is being loaded or unloaded.

Value:
(i)
@TRUE when loading and @FALSE when unloading pen windows.

Returns:
(s) "".

92

GetWindowsExtension

Indicates whether the Windows extension, Windows Plus! is installed.

Value:
(N/A).

Returns:
(i)
@TRUE if the extension is installed, or @FALSE if it is not.

 

SPECIAL FORMAT STRINGS

(tab-delimited lists)

 

ACCESSTIMEOUT

This tab-delimited list contains information about the time-out period associated with the Win32 accessibility features. The accessibility time-out period is the length of time that must pass without keyboard and mouse input before the operating system automatically turns off accessibility features. The accessibility features affected by the time-out are the FilterKeys features (SlowKeys, BounceKeys, and RepeatKeys), MouseKeys, ToggleKeys, and StickyKeys. The accessibility time-out also affects the high contrast mode setting.

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) A set of bit flags that specify properties of the time-out behavior for accessibility features. The following values are defined.

Value Meaning

1 If this flag is set, a time-out period has been set for accessibility features. If this flag is not set, the features will not time out even though a time-out period is specified.

2  If this flag is set, the operating system plays a descending siren sound when the time-out period elapses and the accessibility features are turned off.

3

(i) Specifies the time-out period, in milliseconds.

 

ANIMATIONINFO

This tab-delimited list contains information about the animation effects associated with user actions.

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) Indicates whether minimize and restore animation is enabled or not.

@TRUE = enabled

@FALSE = not enabled.

 

FILTERKEYS

This tab-delimited list contains information about the FilterKeys accessibility feature, which allow a user with disabilities to set the keyboard repeat rate (RepeatKeys), acceptance delay (SlowKeys), and bounce rate (BounceKeys).

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) A set of bit flags that specify properties of the FilterKeys.

Value Meaning

1 The FilterKeys features are on.

2 The FilterKeys features are available.

4 The user can turn the FilterKeys feature on and off by holding down the RIGHT SHIFT key for eight seconds.

8 Windows 2000: A confirmation dialog box appears when the FilterKeys features are activated by using the hot key.

16 If this flag is set, the computer plays a siren sound when the user turns the FilterKeys feature on or off by using the hot key.

32 Windows 2000: A visual indicator is displayed when the FilterKeys features are on.

64 The computer makes a click sound when a key is pressed or accepted. If SlowKeys is on, a click is generated when the key is pressed and again when the keystroke is accepted.

 

3

(i) Specifies the length of time, in milliseconds, that the user must hold down a key before it is accepted by the computer.

4

(i) Specifies the length of time, in milliseconds, that the user must hold down a key before it begins to repeat.

5

(i) Specifies the length of time, in milliseconds, between each repetition of the keystroke.

6

(i) Specifies the amount of time, in milliseconds, that must elapse after releasing a key before the computer will accept a subsequent press of the same key.

 

HIGHCONTRAST

This structure contains information about the high contrast accessibility feature, which sets the appearance scheme of the user interface for maximum visibility for a visually-impaired user, and advises applications to comply with this appearance scheme.

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) A set of bit flags that specify properties of the FilterKeys.

Value Meaning

1 The high contrast feature is on.

2 The high contrast feature is available.

4 The user can turn the high contrast feature on and off by simultaneously pressing the left ALT, left SHIFT, and PRINT SCREEN keys.

8 A confirmation dialog appears when the high contrast feature is activated by using the hot key.

16 A siren is played when the user turns the high contrast feature on or off by using the hot key.

32 A visual indicator is displayed when the high contrast feature is on. This value is not currently used and is ignored.

64 The hot key associated with the high contrast feature can be enabled. An application can retrieve this value, but cannot set it.

3

(s) A string that contains the name of the color scheme that will be set to the default scheme.

 

ICONMETRICS

This tab-delimited list contains the scalable metrics associated with icons.

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) Horizontal space, in pixels, for each arranged icon.

3

(i) Vertical space, in pixels, for each arranged icon.

4

(i) Title-wrapping flag.

@TRUE = icon titles wrap to a new line.

@FALSE = icon titles do not wrap.

 

5

(s) <LOGFONT> format string (see below).

Specifies the font to use for icon titles.

 

MINIMIZEDMETRICS

This tab-delimited list contains the scalable metrics associated with minimized windows.

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) Specifies the width, in pixels, of minimized windows.

3

(i) Specifies the amount of horizontal space, in pixels, between arranged minimized windows.

4

(i) Specifies the amount of vertical space, in pixels, between arranged minimized windows.

5

(i) Specifies the starting position and direction used when arranging minimized windows. The starting position must be one of the following values.

Value Meaning

0 Start at the lower-left corner of the work area.

1 Start at the lower-right corner of the work area.

2 Start at the upper-left corner of the work area.

3 Start at the upper-right corner of the work area.

 

The direction must be one of the following values.

Value Meaning

0 Arrange Left/Right

4 Arrange Up/Down

 

 

MOUSEKEYS

This tab-delimited list contains information about the MouseKeys accessibility feature. When the MouseKeys feature is active, the user can use the numeric keypad to control the mouse pointer, and to click, double-click, drag, and drop. By pressing NUMLOCK, the user can toggle the numeric keypad between mouse control mode and normal operation.

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) A set of bit-flags that specify properties of the FilterKeys feature. The following bit-flag values are defined:

Value Meaning

1 If this flag is set, the MouseKeys feature is on.

2 If this flag is set, the MouseKeys feature is available.

4 If this flag is set, the user can turn the MouseKeys feature on and off by using the hot key, which is LEFT ALT+LEFT SHIFT+NUM LOCK.

8 Windows 2000: A confirmation dialog box appears when the MouseKeys feature is activated by using the hot key.

16 If this flag is set, the system plays a siren sound when the user turns the MouseKeys feature on or off by using the hot key.

32 Windows 2000: A visual indicator is displayed when the MouseKeys feature is on.

64 Windows 2000: The CTRL key increases cursor speed by the value specified by the 5th item in this tab delimited list, and the SHIFT key causes the cursor to delay briefly after moving a single pixel, allowing fine positioning of the cursor. If this value is not specified, the CTRL and SHIFT keys are ignored while the user moves the mouse cursor using the arrow keys.

128 Windows 2000: The numeric keypad moves the mouse when the NUM LOCK key is on. If this flag is not specified, the numeric keypad moves the mouse cursor when the NUM LOCK key is off.

16777216 Windows 2000: The left button is in the "down" state.

33554432 Windows 2000: The right button is in the "down" state.

268435456 Windows 2000: The user has selected the left button for mouse-button actions.

536870912 Windows 2000: The user has selected the right button for mouse-button actions.

2147483648 Windows 2000: The system is processing numeric keypad input as mouse commands.

 

3

(i) Specifies the maximum speed the mouse cursor attains when an arrow key is held down.

Windows NT/2000: Valid values are from 10 to 360.

4

(i) Specifies the length of time, in milliseconds, that it takes for the mouse cursor to reach maximum speed when an arrow key is held down. Valid values are from 1000 to 5000.

5

(i) Specifies the multiplier to apply to the mouse cursor speed when the user holds down the CTRL key while using the arrow keys to move the cursor. This value is ignored if the flags value 64 is not set.

6

(i) Reserved for future use. It must be set to zero.

7

(i) Reserved for future use. It must be set to zero.

 

NONCLIENTMETRICS

This tab-delimited list contains the scalable metrics associated with the nonclient area of a nonminimized window..

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) Specifies the thickness, in pixels, of the sizing border.

3

(i) Specifies the width, in pixels, of a standard vertical scroll bar.

4

(i) Specifies the height, in pixels, of a standard horizontal scroll bar.

5

(i) Specifies the width, in pixels, of caption buttons.

6

(i) Specifies the height, in pixels, of caption buttons.

7

(s) <LOGFONT> format string (see below).

Contains information about the caption font.

8

(i) Specifies the width, in pixels, of small caption buttons.

9

(i) Specifies the height, in pixels, of small captions.

10

(s) <LOGFONT> format string (see below).

Contains information about the small caption font.

11

(i) Specifies the width, in pixels, of menu-bar buttons.

12

(i) Specifies the height, in pixels, of a menu bar.

13

(s) <LOGFONT> format string (see below).

Contains information about the font used in menu bars.

14

(s) <LOGFONT> format string (see below).

Contains information about the font used in status bars and tooltips.

15

(s) <LOGFONT> format string (see below).

Contains information about the font used in message boxes.

 

 

SERIALKEYS

This tab-delimited list contains information about the SerialKeys accessibility feature, which interprets data from a communication aid attached to a serial port as commands causing the system to simulate keyboard and mouse input.

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) Specifies a combination of the following values:

Value Meaning

1 The SerialKeys feature is on.

2 The SerialKeys feature is available.

4 A visual indicator is displayed when the SerialKeys feature is on. This value is not currently used and is ignored.

 

3

(s) The name of the serial port that receives input from the communication aid when the SerialKeys feature is on. If no port is being used, this member is "*NULL*". If the value is "Auto", the system watches all unused serial ports for input from communication aids.

4

(s) Reserved; must be "*NULL*"

5

(i) The baud rate setting for the serial port specified. If serial port specified in this list is "*NULL*", this item is zero.This item should be set to one of the following values: 110, 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 38400, 56000, 57600, 115200, 128000, 256000

 

6

(i) Specifies the state of the port. If serial port specified in this list is "*NULL*", this item will be zero; otherwise, it is one of the following values:

Value Meaning

0 All input on this port is ignored by the SerialKeys feature.

1 Input on this port is watched for SerialKeys activation sequences when no other application has the port open.

2 All input on this port is treated as SerialKeys commands.

 

7

(i) Specifies the active port.

 

SOUNDSENTRY

This tab-delimited list contains information about the SoundSentry accessibility feature. When the SoundSentry feature is on, the computer displays a visual indication only when a sound is generated.

 

Windows NT/2000: The visual indication is displayed when a sound is generated through either the multimedia sound services or through the computer's speaker.

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) A set of bit flags that specify properties of the SoundSentry feature. The following bit-flag values are defined:

Value Meaning

1 If this flag is set, the SoundSentry feature is on.

2 If this flag is set, the SoundSentry feature is available.

4 This flag is not implemented.

 

3

(i) Windows NT/2000: Reserved for future use. It must be set to zero.

 

4

(i) Windows NT/2000: Reserved for future use. It must be set to zero.

 

5

(i) Windows NT/2000: Reserved for future use. It must be set to zero.

 

6

(i) Windows NT/2000: Reserved for future use. It must be set to zero.

 

7

(i) Windows NT/2000: Reserved for future use. It must be set to zero.

 

8

(i) Windows NT/2000: Reserved for future use. It must be set to zero.

 

9

(i) Specifies the visual signal to display when a sound is generated by a Windows-based application or an MS-DOS application running in a window. This item can be one of the following values:

Value Meaning

 0 No visual signal.

 1 Flash the title bar of the active window.

 2 Flash the active window.

 3 Flash the entire display.

 4 Call the routine exported by the DLL specified by item 11, in this list.

 

10

(i) Windows NT/2000: Reserved for future use. It must be set to zero.

 

11

(s) name of the DLL that contains a callback function. This item is "*NULL*" if no DLL is used.

 

12

(i) Reserved for future use. It must be set to zero.

 

STICKYKEYS

This tab-delimited list contains information about the StickyKeys accessibility feature. When the StickyKeys feature is on, the user can press a modifier key (SHIFT, CTRL, or ALT) and then another key in sequence rather than at the same time, to enter shifted (modified) characters and other key combinations. Pressing a modifier key once latches the key down until the user presses a non-modifier key or clicks a mouse button. Pressing a modifier key twice locks the key until the user presses the key a third time.

 

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) A set of bit-flags that specify properties of the StickyKeys feature. The following bit-flag values are defined:

Value Meaning

1 If this flag is set, the StickyKeys feature is on.

2 If this flag is set, the StickyKeys feature is available.

4 If this flag is set, the user can turn the StickyKeys feature on and off by pressing the SHIFT key five times.

8 Windows 2000: A confirmation dialog appears when the StickyKeys feature is activated by using the hot key.

16 If this flag is set, the system plays a siren sound when the user turns the StickyKeys feature on or off by using the hot key.

32 Windows 2000: A visual indicator should be displayed when the StickyKeys feature is on.

64 If this flag is set, the system plays a sound when the user latches, locks, or releases modifier keys using the StickyKeys feature.

128 If this flag is set, pressing a modifier key twice in a row locks down the key until the user presses it a third time.

256 If this flag is set, releasing a modifier key that has been pressed in combination with any other key turns off the StickyKeys feature.

65536 Windows 2000: The left SHIFT key is locked. (cannot set this value)

131072 Windows 2000: The right SHIFT key is locked. (cannot set this value)

262144 Windows 2000: The left CTRL key is locked. (cannot set this value)

524288 Windows 2000: The right CTRL key is locked. (cannot set this value)

1048576 Windows 2000: The left ALT key is locked. (cannot set this value)

2097152 Windows 2000: The right ALT key is locked. (cannot set this value)

4194304 Windows 2000: The left Windows key is locked.

8388608 Windows 2000: The right Windows key is locked.

16777216 Windows 2000: The left SHIFT key is latched. (cannot set this value)

33554432 Windows 2000: The right SHIFT key is latched. (cannot set this value)

67108864 Windows 2000: The left CTRL key is latched. (cannot set this value)

134217728 Windows 2000: The right CTRL key is latched. (cannot set this value)

268435456 Windows 2000: The left ALT key is latched. (cannot set this value)

536870912 Windows 2000: The right ALT key is latched. (cannot set this value)

1073741824 Windows 2000: The left Windows key is latched.

-2147483648 Windows 2000: The right Windows key is latched.

 

 

 

TOGGLEKEYS

This tab-delimited list contains information about the ToggleKeys accessibility feature. When the ToggleKeys feature is on, the computer emits a high-pitched tone whenever the user turns on the CAPS LOCK, NUM LOCK, or SCROLL LOCK key, and a low-pitched tone whenever the user turns off one of those keys.

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i) A set of bit flags that specify properties of the ToggleKeys feature. The following bit flag values are defined:

Value Meaning

1 If this flag is set, the ToggleKeys feature is on.

2 If this flag is set, the ToggleKeys feature is available.

4 If this flag is set, the user can turn the ToggleKeys feature on and off by holding down the NUM LOCK key for eight seconds.

Windows 2000: A confirmation dialog box appears when the ToggleKeys feature is activated by using the hot key.

16 If this flag is set, the system plays a siren sound when the user turns the ToggleKeys feature on or off by using the hot key.

 

 

LOGFONT (vertical-bar delimited list)

This vertical-bar delimited list defines the attributes of a font

Item #

Meaning

1

(i) Specifies the size, in bytes, of this structure.

2

(i)Specifies the height, in logical units, of the font's character cell or character. The character height value (also known as the em height) is the character cell height value minus the internal-leading value. The font mapper interprets the value specified, in the following manner.

Value Meaning

> 0 The font mapper transforms this value into device units and matches it against the cell height of the available fonts.

0 The font mapper uses a default height value when it searches for a match.

< 0 The font mapper transforms this value into device units and matches its absolute value against the character height of the available fonts.

 

For all height comparisons, the font mapper looks for the largest font that does not exceed the requested size. This mapping occurs when the font is used for the first time.

 

3

(i) Specifies the average width, in logical units, of characters in the font. If this value is zero, the aspect ratio of the device is matched against the digitization aspect ratio of the available fonts to find the closest match, determined by the absolute value of the difference.

 

4

(i) Specifies the angle, in tenths of degrees, between the escapement vector and the x-axis of the device. The escapement vector is parallel to the base line of a row of text.

 

Windows NT/2000/XP: When the graphics mode is set to GM_ADVANCED, you can specify the escapement angle of the string independently of the orientation angle of the string's characters.

When the graphics mode is set to GM_COMPATIBLE, This value specifies both the escapement and orientation. You should set this value and item 5 (orientation) to the same value.

 

5

(i) orientation: Specifies the angle, in tenths of degrees, between each character's base line and the x-axis of the device.

 

6

(i) Specifies the weight of the font in the range 0 through 1000. For example, 400 is normal and 700 is bold. If this value is zero, a default weight is used.

 

Description Value

THIN 100

EXTRALIGHT 200

ULTRALIGHT 200

LIGHT 300

NORMAL 400

REGULAR 400

MEDIUM 500

SEMIBOLD 600

DEMIBOLD 600

BOLD 700

EXTRABOLD 800

ULTRABOLD 800

HEAVY 900

BLACK 900

 

 

7

(i) Specifies an italic font if value is NON-ZERO.

8

(i) Specifies an underlined font if value is NON-ZERO.

9

(i) Specifies a strikeout font if value is NON-ZERO.

10

(i) Specifies the character set. The following values are predefined.

Value Charset

0 ANSI_CHARSET

1 DEFAULT_CHARSET

2 SYMBOL_CHARSET

77 MAC_CHARSET

128 SHIFTJIS_CHARSET

129 HANGEUL_CHARSET

129 HANGUL_CHARSET

134 GB2312_CHARSET

136 CHINESEBIG5_CHARSET

161 GREEK_CHARSET

162 TURKISH_CHARSET

163 VIETNAMESE_CHARSET

186  BALTIC_CHARSET

204 RUSSIAN_CHARSET

238 EASTEUROPE_CHARSET

255 OEM_CHARSET

 

Korean language edition of Windows:

130 JOHAB_CHARSET

Middle East language edition of Windows:

178 ARABIC_CHARSET

177 HEBREW_CHARSET

Thai language edition of Windows:

222 THAI_CHARSET

 

The OEM_CHARSET value specifies a character set that is operating-system dependent.

 

Windows NT/2000/XP: DEFAULT_CHARSET is set to a value based on the current system locale. For example, when the system locale is English (United States), it is set as ANSI_CHARSET.

 

Fonts with other character sets may exist in the operating system. If an application uses a font with an unknown character set, it should not attempt to translate or interpret strings that are rendered with that font.

 

This parameter is important in the font mapping process. To ensure consistent results, specify a specific character set. If you specify a typeface name in item 15 (FaceName), make sure that this value matches the character set of the typeface specified in item 15 (FaceName).

 

11

(i) Specifies the output precision. The output precision defines how closely the output must match the requested font's height, width, character orientation, escapement, pitch, and font type. It can be one of the following values.

Value Meaning

1 This value is not used by the font mapper, but it is returned when raster fonts are enumerated.

2 Specifies the default font mapper behavior.

3 Windows NT/2000/XP: This value is not used by the font mapper, but it is returned when TrueType, other outline-based fonts, and vector fonts are enumerated.

4 Instructs the font mapper to choose a TrueType font when the system contains multiple fonts with the same name.

5 Instructs the font mapper to choose a Device font when the system contains multiple fonts with the same name.

6 Instructs the font mapper to choose a raster font when the system contains multiple fonts with the same name.

7 Instructs the font mapper to choose from only TrueType fonts. If there are no TrueType fonts installed in the system, the font mapper returns to default behavior.

8 Windows NT/2000/XP: This value instructs the font mapper to choose from TrueType and other outline-based fonts.

 

Applications can use the 4, 5, 6, values to control how the font mapper chooses a font when the operating system contains more than one font with a specified name. For example, if an operating system contains a font named Symbol in raster and TrueType form, specifying the value 4 forces the font mapper to choose the TrueType version. Specifying the value 7 forces the font mapper to choose a TrueType font, even if it must substitute a TrueType font of another name.

 

12

Specifies the clipping precision. The clipping precision defines how to clip characters that are partially outside the clipping region. It can be one or more of the following values.

Value Meaning

0 Specifies default clipping behavior.

1 Not used.

2 Not used by the font mapper, but is returned when raster, vector, or TrueType fonts are enumerated. Windows NT/2000/XP: For compatibility, this value is always returned when enumerating fonts.

15 Not used.

16 When this value is used, the rotation for all fonts depends on whether the orientation of the coordinate system is left-handed or right-handed. If not used, device fonts always rotate counterclockwise, but the rotation of other fonts is dependent on the orientation of the coordinate system.

32 Not used.

128 You must specify this flag to use an embedded read-only font.

 

13

Specifies the output quality. The output quality defines how carefully the graphics device interface (GDI) must attempt to match the logical-font attributes to those of an actual physical font. It can be one of the following values.

Value Meaning

0 Appearance of the font does not matter.

1 Appearance of the font is less important than when PROOF_QUALITY is used. For GDI raster fonts, scaling is enabled, which means that more font sizes are available, but the quality may be lower. Bold, italic, underline, and strikeout fonts are synthesized if necessary.

2 Character quality of the font is more important than exact matching of the logical-font attributes. For GDI raster fonts, scaling is disabled and the font closest in size is chosen. Although the chosen font size may not be mapped exactly when PROOF_QUALITY is used, the quality of the font is high and there is no distortion of appearance. Bold, italic, underline, and strikeout fonts are synthesized if necessary.

Windows NT 4.0 and later: Font is never antialiased.

Windows NT 4.0 and later: Font is always antialiased if the font supports it and the size of the font is not too small or too large.

Windows XP: If set, text is rendered (when possible) using ClearType antialiasing method. See Remarks for more information.

 

If neither flag 3 or 4 is selected, the font is antialiased only if the user chooses smooth screen fonts in Control Panel.

 

14

Specifies the pitch and family of the font. The two low-order bits specify the pitch of the font and can be one of the following values.

Value Pitch

0 DEFAULT_PITCH
1
 FIXED_PITCH
2
 VARIABLE_PITCH

 

Bits 4 through 7 of the member specify the font family and can be one of the following values.

Value Family

0 DONTCARE - Don't care or don't know.

16 ROMAN - Fonts with variable stroke width (proportional) and with serifs. MS® Serif is an example.

32 SWISS - Fonts with variable stroke width (proportional) and without serifs. MS® Sans Serif is an example.

48 MODERN - Fonts with constant stroke width (monospace), with or without serifs. Monospace fonts are usually modern. Pica, Elite, and CourierNew® are examples

64 SCRIPT - Fonts designed to look like handwriting. Script and Cursive are examples.

80 DECORATIVE - Novelty fonts. Old English is an example.

 

 

15

(s) A string that specifies the typeface name of the font. The length of this string must not exceed 32 characters, including the null terminator. If this value is an empty string, GDI uses the first font that matches the other specified attributes.

 

 

Note: If this function is unable to execute for any reason, we return the string "*UNSUPPORTED*"

Example:


request = 114 ;GetScreenSaverRunning
value = 0
update = 0
If SysParamInfo( request, value, update) == 1 Then Message("SysParamInfo ", "Screen saver is active")
See Also:

Environment, MouseInfo, NetInfo, WinMetrics, WinSysInfo, WinResources