TOGGLEKEYS

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure contains information about the toggle keys accessibility option. When the toggle keys option is on, the device emits a high-pitched sound whenever the user turns on the CAPS LOCK, NUM LOCK, or SCROLL LOCK key and emits a low-pitched sound whenever the user turns off one of those keys.

Syntax

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

Members

  • cbSize
    Unsigned integer that specifies the size, in bytes, of this structure.
  • dwFlags
    DWORD that contains a set of bit flags that specify properties for the toggle keys option. The following table shows the possible values.

    Value Description

    TKF_AVAILABLE

    The toggle keys option is available for use.

    TKF_HOTKEYACTIVE

    The user can turn the toggle keys option on and off by holding down the NUM LOCK key for 8 seconds.

    TKF_HOTKEYSOUND

    The system plays a siren sound when the user turns the toggle keys option on or off by using the hot key.

    TKF_TOGGLEKEYSON

    The toggle keys option is on.

Remarks

Use a TOGGLEKEYS structure when you call the SystemParametersInfo function with the wAction parameter set to SPI_GETTOGGLEKEYS or SPI_SETTOGGLEKEYS. When using SPI_GETTOGGLEKEYS, you must specify the cbSize member of the TOGGLEKEYS structure; the SystemParametersInfo function fills in the remaining members. Specify all structure members when using the SPI_SETTOGGLEKEYS value.

Requirements

Header winuser.h
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

SystemParametersInfo

Concepts

Enabling Toggle Keys

Other Resources

Accessibility Structures