SOUNDSENTRY

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This structure contains information about the sound sentry accessibility option. When the sound sentry option is on, the device displays a visual indication when a sound is generated through the internal speaker of the device.

Syntax

typedef struct tagSOUNDSENTRY{
  UINT cbSize;
  DWORD dwFlags;
  DWORD iFSTextEffect;
  DWORD iFSTextEffectMSec;
  DWORD iFSTextEffectColorBits;
  DWORD iFSGrafEffect;
  DWORD iFSGrafEffectMSec;
  DWORD iFSGrafEffectColor;
  DWORD iWindowsEffect;
  DWORD iWindowsEffectMSec;
  LPTSTR lpszWindowsEffectDLL;
  DWORD iWindowsEffectOrdinal;
} SOUNDSENTRY, *LPSOUNDSENTRY;

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 sound sentry option. The following table shows the possible values.

  Value	Description
  SSF_AVAILABLE	The sound sentry option is available for use.
  SSF_SOUNDSENTRYON	The sound sentry option is on.

• iFSTextEffect
  Not supported.

• iFSTextEffectMSec
  Not supported.

• iFSTextEffectColorBits
  Not supported.

• iFSGrafEffect
  Not supported.

• iFSGrafEffectMSec
  Not supported.

• iFSGrafEffectColor
  Not supported.

• iWindowsEffect
  DWORD that specifies a visual signal to display when a Windows Embedded CE–based application running in a window generates a sound. The following table shows the possible values.

  Value	Description
  SSWF_DISPLAY	Causes the entire screen to flash.
  SSWF_NONE	Causes no visual signal.
  SSWF_TITLE	Causes the title bar of the active window to flash.
  SSWF_WINDOW	Causes the active window to flash.

• iWindowsEffectMSec
  Not supported.

• lpszWindowsEffectDLL
  Not supported.

• iWindowsEffectOrdinal
  Reserved for future use. Set to 0.

Remarks

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

Because Windows Embedded CE does not support full screen virtual machines, Windows Embedded CE does not support the iFSTextEffect, iFSTextEffectMSec, iFSTextEffectColorBits, iFSGrafEffect, iFSGrafEffectMSec, iFSGrafEffectColor, iWindowsEffectMSec, and lpszWindowsEffectDLL members of the Windows-based desktop version of the SOUNDSENTRY structure.

Requirements

See Also

Reference

SystemParametersInfo

Concepts

Enabling Sound Sentry

Other Resources

Accessibility Structures