Edit

Share via

SOUNDSENTRYA structure (winuser.h)

  • Article

Contains information about the SoundSentry accessibility feature. When the SoundSentry feature is on, the computer displays a visual indication only when a sound is generated.

Windows 95/98: The visual indication is displayed when a sound is generated through the computer's internal speaker.

Windows NT/2000: The visual indication is displayed when a sound is generated through either the multimedia sound services or through the computer's speaker.

Syntax

typedef struct tagSOUNDSENTRYA {
  UINT  cbSize;
  DWORD dwFlags;
  DWORD iFSTextEffect;
  DWORD iFSTextEffectMSec;
  DWORD iFSTextEffectColorBits;
  DWORD iFSGrafEffect;
  DWORD iFSGrafEffectMSec;
  DWORD iFSGrafEffectColor;
  DWORD iWindowsEffect;
  DWORD iWindowsEffectMSec;
  LPSTR lpszWindowsEffectDLL;
  DWORD iWindowsEffectOrdinal;
} SOUNDSENTRYA, *LPSOUNDSENTRYA;

Members

cbSize

Type: UINT

Specifies the size, in bytes, of this structure.

dwFlags

Type: DWORD

A set of bit flags that specify properties of the SoundSentry feature. The following bit-flag values are defined:

Value Meaning
SSF_AVAILABLE
0x00000002
 If this flag is set, the SoundSentry feature is available.
SSF_INDICATOR
0x00000004
 This flag is not implemented.
SSF_SOUNDSENTRYON
0x00000001
 If this flag is set, the SoundSentry feature is on.

iFSTextEffect

Type: DWORD

Windows 95/98: Specifies the visual signal to present when a text-mode application generates a sound while running in a full-screen virtual machine. This member can be one of the following values:

Value Meaning
SSTF_BORDER
2
 Flash the screen border (that is, the overscan area), which is unavailable on some displays.
SSTF_CHARS
1
 Flash characters in the corner of the screen.
SSTF_DISPLAY
3
 Flash the entire display.
SSTF_NONE
0
 No visual signal
 

Windows NT/2000: This member is reserved for future use. It must be set to zero.

iFSTextEffectMSec

Type: DWORD

Windows 95/98: Specifies the duration, in milliseconds, of the visual signal that is displayed when a full-screen, text-mode application generates a sound.

Windows NT/2000: This member is reserved for future use. It must be set to zero.

iFSTextEffectColorBits

Type: DWORD

Windows 95/98: Specifies the RGB value of the color to be used when displaying the visual signal shown when a full-screen, text-mode application generates a sound.

Windows NT/2000: This member is reserved for future use. It must be set to zero.

iFSGrafEffect

Type: DWORD

Windows 95/98: Specifies the visual signal to present when a graphics-mode application generates a sound while running in a full-screen virtual machine. This member can be one of the following values:

Value Meaning
SSGF_DISPLAY
3
 Flash the entire display.
SSGF_NONE
0
 No visual signal.
 

Windows NT/2000: This member is reserved for future use. It must be set to zero.

iFSGrafEffectMSec

Type: DWORD

Windows 95/98: Specifies the duration, in milliseconds, of the visual signal that is displayed when a full-screen, graphics-mode application generates a sound.

Windows NT/2000: This member is reserved for future use. It must be set to zero.

iFSGrafEffectColor

Type: DWORD

Windows 95/98: Specifies the RGB value of the color to be used when displaying the visual signal shown when a full-screen, graphics-mode application generates a sound.

Windows NT/2000: This member is reserved for future use. It must be set to zero.

iWindowsEffect

Type: DWORD

Specifies the visual signal to display when a sound is generated by a Windows-based application or an MS-DOS application running in a window. This member can be one of the following values:

Value Meaning
SSWF_CUSTOM
4
 Use a custom visual signal.
SSWF_DISPLAY
3
 Flash the entire display.
SSWF_NONE
0
 No visual signal.
SSWF_TITLE
1
 Flash the title bar of the active window.
SSWF_WINDOW
2
 Flash the active window.

iWindowsEffectMSec

Type: DWORD

Windows 95/98: Specifies the duration, in milliseconds, of the visual signal that is displayed when a Win32-based application (or an application running in a window) generates a sound.

Windows NT/2000: This member is reserved for future use. It must be set to zero.

lpszWindowsEffectDLL

Type: LPTSTR

This member is reserved for future use. It should be set to NULL.

iWindowsEffectOrdinal

Type: DWORD

This member is reserved for future use. It must be set to zero.

Remarks

An application uses a SOUNDSENTRY structure when calling the SystemParametersInfo function with the uiAction parameter set to SPI_GETSOUNDSENTRY or SPI_SETSOUNDSENTRY. When using SPI_GETSOUNDSENTRY, an application must specify the cbSize member of the SOUNDSENTRY structure; the SystemParametersInfo function fills the remaining members. An application must specify the cbSize, dwFlags, and iWindowsEffect members when using the SPI_SETSOUNDSENTRY value.

Note

The winuser.h header defines SOUNDSENTRY as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Header winuser.h (include Windows.h)

See also

Accessibility Structures

SoundSentryProc

SystemParametersInfo