TOGGLEKEYS

  • Article

The TOGGLEKEYS structure 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.

typedef struct tagTOGGLEKEYS { 
    DWORD  cbSize; 
    DWORD  dwFlags; 
} TOGGLEKEYS, *LPTOGGLEKEYS;

Members

  • cbSize
    Specifies the size, in bytes, of this structure.
  • dwFlags
    A set of bit flags that specify properties of the ToggleKeys feature. The following bit flag values are defined:
    Value Meaning
    TKF_AVAILABLE If this flag is set, the ToggleKeys feature is available.
    TKF_CONFIRMHOTKEY Windows 95/98, Windows 2000: A confirmation dialog box appears when the ToggleKeys feature is activated by using the hot key.
    TKF_HOTKEYACTIVE 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.
    TKF_HOTKEYSOUND 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.
    TKF_INDICATOR This flag is not implemented.
    TKF_TOGGLEKEYSON If this flag is set, the ToggleKeys feature is on.

Remarks

An application uses a TOGGLEKEYS structure when calling the SystemParametersInfo function with the uiAction parameter set to SPI_GETTOGGLEKEYS or SPI_SETTOGGLEKEYS. When using SPI_GETTOGGLEKEYS, an application must specify the cbSize member of the TOGGLEKEYS structure; the SystemParametersInfo function fills the remaining members. An application must specify all structure members when using the SETTOGGLEKEYS value.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.5 or later.
**  Windows 95/98/Me:** Included in Windows 95 or later.
**  Header:** Declared in Winuser.h; include Windows.h.

See Also

Accessibility Structures, SystemParametersInfo