ACCESSTIMEOUT

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure contains information about the time-out period associated with the accessibility options. This time-out period is the length of time that must pass without keyboard, mouse, or touch input before the operating system (OS) automatically turns off the accessibility options. The accessibility options that the time-out affects are mouse keys, toggle keys, high-contrast mode, and sticky keys. Use the accessibility time-out on devices that several users share so that options selected by one user do not inconvenience a subsequent user.

Syntax

typedef struct tagACCESSTIMEOUT{
  UINT cbSize;
  DWORD dwFlags;
  DWORD iTimeOutMSec;
} ACCESSTIMEOUT, *LPACCESSTIMEOUT;

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 of the time-out option. The following table shows the possible values.

  Value	Description
  ATF_AVAILABLE	The accessibility time-out option is available for use. An application can retrieve this value but cannot set it.
  ATF_ONOFFFEEDBACK	The OS plays a descending siren sound when the time-out period elapses and the OS turns off the accessibility options.
  ATF_TIMEOUTON	A time-out period is set for accessibility options. If this flag is not set, the options do not time out even if an application specifies a time-out period.

• iTimeOutMSec
  DWORD that specifies the length of the time-out period, in milliseconds.

Remarks

Use an ACCESSTIMEOUT structure when you call the SystemParametersInfo function with the uiAction parameter set to the SPI_GETACCESSTIMEOUT or SPI_SETACCESSTIMEOUT value. When using SPI_GETACCESSTIMEOUT, you must specify the cbSize member of the ACCESSTIMEOUT structure; the SystemParametersInfo function fills in the remaining members. Specify all structure members when using the SPI_SETACCESSTIMEOUT value.

Requirements

See Also

Reference

SystemParametersInfo

Concepts

Setting Accessibility Time-out Periods

Other Resources

Accessibility Structures