SpQuerySysValue

From EDM2
Jump to: navigation, search

Queries a system value.

Syntax: value = spQuerySysValue ( [ hwndDesktop , ] valueID )

Parameters:

  • hwndDesktop – Desktop-window handle. If ommited the default desktop
  • handle (HWND_DESKTOP) will be used.
  • valueID – Identifier of system value to be queried.
Table 4: Value IDs for spQuerySysValue
valueID Description
SV_ALARM 0 if the alarm sound generated by WinAlarm is disabled.
SV_ALTMNEMONIC 0 if the mnemonic is made up of ROMAN characters, other values if the mnemonic is made up of KATAKANA characters.
SV_ANIMATION 0 when animation is set off.
SV_BEGINDRAG Mouse begin drag (low word=mouse message id (WM_*), high word=keyboard control code (KC_*)).
SV_BEGINDRAGKB Keyboard begin drag (low word=virtual key code (VK_*), high

word=keyboard control code (KC_*)).

SV_BEGINSELECT Mouse begin swipe select (low word=mouse message id

(WM_*), high word=keyboard control code (KC_*)).

SV_BEGINSELECTKB Keyboard begin swipe select (low word=virtual key code

(VK_*), high word=keyboard control code (KC_*)).

SV_CICONTEXTLINES Maximum number of lines that the icon text may occupy for a

minimized window.

SV_CONTEXTHELP Mouse control for pop-up menu (low word=mouse message id

(WM_*), high word=keyboard control code (KC_*)).

SV_CONTEXTHELPKB Keyboard control for pop-up menu (low word=virtual key code

(VK_*), high word=keyboard control code (KC_*)).

SV_CONTEXTMENU Mouse request pop-up menu (low word=mouse message id

(WM_*), high word=keyboard control code (KC_*)).

SV_CONTEXTMENUKB Keyboard request pop-up menu (low word=virtual key code

(VK_*), high word=keyboard control code (KC_*)).

SV_CMOUSEBUTTONS The number of buttons on the pointing device (zero if no

pointing device is installed).

SV_CTIMERS Count of available timers.
SV_CURSORLEVEL The cursor hide level.
SV_CURSORRATE Cursor blink rate, in milliseconds.
SV_CXBORDER Width of the nominal-width border.
SV_CXBYTEALIGN Horizontal count of pels for alignment.
SV_CXDBLCLK Width of the pointing device double-click sensitive area. The

default is the system-font character width.

SV_CXDLGFRAME Width of the dialog-frame border.
SV_CXFULLSCREEN Width of the client area when the window is full screen.
SV_CXHSCROLLARROW Width of the horizontal scroll-bar arrow bit maps.
SV_CXHSLIDER Width of the horizontal scroll-bar thumb.
SV_CXICON Icon width.
SV_CXICONTEXTWIDTH Maximum number of characters per line allowed in the icon text

for a minimized window.

SV_CXMINMAXBUTTON Width of the minimize/maximize buttons.
SV_CXMOTIONSTART The number of pels that a pointing device must be moved in the horizontal direction, while the button is depressed, before a WM_BUTTONxMOTIONSTR message is sent.
SV_CXPOINTER Pointer width.
SV_CXSCREEN Width of the screen.
SV_CXSIZEBORDER Width of the sizing border.
SV_CXVSCROLL Width of the vertical scroll-bar.
SV_CYBORDER Height of the nominal-width border.
SV_CYBYTEALIGN Vertical count of pels for alignment.
SV_CYDBLCLK Height of the pointing device double-click sensitive area. The

default is half the height of the system font character height.

SV_CYDLGFRAME Height of the dialog-frame border.
SV_CYFULLSCREEN Height of the client area when the window is full screen

(excluding menu height).

SV_CYHSCROLL Height of the horizontal scroll-bar.
SV_CYICON Icon height.
SV_CYMENU Height of the single-line menu height.
SV_CYMINMAXBUTTON Height of the minimize/maximize buttons.
SV_CYMOTIONSTART The number of pels that a pointing device must be moved in

the vertical direction, while the button is depressed, before a

WM_BUTTONxMOTIONSTR message is sent.
SV_CYPOINTER Pointer height.
SV_CYSCREEN Height of the screen.
SV_CYSIZEBORDER Height of the sizing border.
SV_CYTITLEBAR Height of the caption.
SV_CYVSCROLLARROW Height of the vertical scroll-bar arrow bit maps.
SV_CYVSLIDER Height of the vertical scroll-bar thumb.
SV_DBLCLKTIME Pointing device double-click time, in milliseconds.
SV_DEBUG 0 indicates this is not a debug system.
SV_ENDDRAG Mouse end drag (low word=mouse message id (WM_*), high

word=keyboard control code (KC_*)).

SV_ENDDRAGKB Keyboard end drag (low word=virtual key code (VK_*), high

word=keyboard control code (KC_*)).

SV_ENDSELECT Mouse select or end swipe select (low word=mouse message

id (WM_*), high word=keyboard control code (KC_*)).

SV_ENDSELECTKB Keybaord select or end swipe select (low word=virtual key code

(VK_*), high word=keyboard control code (KC_*)).

SV_ERRORDURATION Duration for error alarms generated by WinAlarm.
SV_ERRORFREQ Frequency for error alarms generated by WinAlarm.
SV_EXTRAKEYBEEP When non 0, the press of a key that does not exist on the

Enhanced keyboard causes the system to generate a beep.

SV_FIRSTSCROLLRATE The delay (in milliseconds) before autoscrolling starts, when

using a scroll bar.

SV_INSERTMODE Non 0 if the system is in insert mode (for edit and multi-line edit

controls); 0 if in overtype mode. This system value is toggled by the system when the insert key is toggled, regardless of which window has the focus at the time.

SV_KBDALTERED Hardware ID of the newly attached keyboard.

Note: The OS/2 National Language Support is only loaded once per system IPL. The OS/2 NLS translation is based partially on the type of keyboard device attached to the system. There are two main keyboard device types: PC AT styled and Enhanced styled. Hot Plugging between these two types of devices may result in typing anomalies due to a mismatch in the NLS device tables loaded and that of the attached device. It is strongly recommended that keyboard hot plugging be limited to the device type that the system was IPL'd with. In addition, OS/2 support will default to the 101/102 key Enhanced keyboard if no keyboard or a NetServer Mode password was in use during system IPL. (See Category 4, IOCtls 77h and 7Ah for more information on keyboard devices and types.)

SV_LOCKSTARTINPUT 0 when the type ahead function is disabled; non 0 when the

type ahead function is enabled

SV_MENUROLLDOWNDELAY The delay in milliseconds before displaying a pull down referred

to from a submenu item, when the button is already down as the pointer moves onto the submenu item.

SV_MENUROLLUPDELAY The delay in milliseconds before hiding a pull down referred to

from a submenu item, when the button is already down as the pointer moves off the submenu item.

SV_MONOICONS When non 0 preference is given to black and white icons when

selecting which icon resource definition to use on the screen. Black and white icons may have more clarity than color icons on LCD and Plasma display screens.

SV_MOUSEPRESENT When non 0 a mouse pointing device is attached to the system.
SV_NOTEDURATION Duration for note alarms generated by WinAlarm.
SV_NOTEFREQ Frequency for note alarms generated by WinAlarm.
SV_OPEN Mouse open (low word=mouse message id (WM_*), high

word=keyboard control code (KC_*)).

SV_OPENKB Keyboard open (low word=virtual key code (VK_*), high

word=keyboard control code (KC_*)).

SV_POINTERLEVEL Pointer hide level. If the pointer level is zero, the pointer is

visible. If it is greater than zero, the pointer is not visible. The WinShowPointer call is invoked to increment and decrement the SV_POINTERLEVEL, but its value cannot become negative.

SV_PRINTSCREEN Non 0 when the Print Screen function is enabled; 0 when the

Print Screen function is disabled.

SV_SCROLLRATE The delay (in milliseconds) between scroll operations, when

using a scroll bar.

SV_SETLIGHTS When non 0, the appropriate light is set when the keyboard

state table is set.

SV_SINGLESELECT Mouse select (low word=mouse message id (WM_*), high

word=keyboard control code (KC_*)).

SV_TASKLISTMOUSEACCESS Determines whether the task list is displayed when mouse

buttons 1 and 2 are pressed simultaneously, or when mouse button 2 is pressed by itself, or for no mouse gesture.

SV_TEXTEDIT Mouse begin direct name edit (low word=mouse message id

(WM_*), high word=keyboard control code (KC_*)).

SV_TEXTEDITKB Keyboard begin direct name edit (low word=virtual key code

(VK_*), high word=keyboard control code (KC_*)).

SV_TRACKRECTLEVEL The hide level of the tracking rectangle (zero if visible, greater than zero if not).
SV_SWAPBUTTON Non 0 if pointing device buttons are swapped. Normally, the pointing device buttons are set for right-handed use. Setting this value changes them for left-handed use.

If non 0, WM_LBUTTON* messages are returned when the user presses the right button, and WM_RBUTTON* messages are returned when the left button is pressed. Modifying this value affects the entire system. Applications should not normally read or set this value; users update this value by means of the user interface shell to suit their requirements.

SV_WARNINGDURATION Duration for warning alarms generated by WinAlarm.
SV_WARNINGFREQ Frequency for warning alarms generated by WinAlarm.

Returns:

  • 0 – Error occurred
  • >0 – System value. Dimensions are in pels and times are in milliseconds.

Example Code:

/* startlpx.cmd (spUtils Example Code) */
/* start wps object <LAUNCHPAD_x> where x is current screen width */

CALL RXFUNCADD 'SysSetObjectData','RexxUtil','SysSetObjectData'CALL
RXFUNCADD 'spLoadFuncs','spUtils','spLoadFuncs'
CALL spLoadFuncs

obj='<LAUNCHPAD_'||spQuerySysValue('SV_CXSCREEN')||'>'
CALL SysSetObjectData obj,'OPEN=DEFAULT'