SOUNDSENTRY Structure
Type SOUNDSENTRY
cbSize As Long
dwFlags As Long
iFSTextEffect As Long
iFSTextEffectMSec As Long
iFSTextEffectColorBits As Long
iFSGrafEffect As Long
iFSGrafEffectMSec As Long
iFSGrafEffectColor As Long
iWindowsEffect As Long
iWindowsEffectMSec As Long
lpszWindowsEffectDLL As String
iWindowsEffectOrdinal As Long
End Type
Description & Usage
The SOUNDSENTRY structure stores information about the SoundSentry accessibility feature. SoundSentry displays a visual cue whenever a sound is made. Windows NT, 2000: SoundSentry works for sounds played through both the internal speaker and multimedia devices. Windows 95, 98: SoundSentry only works for sounds played through the internal speaker.
Visual Basic-Specific Issues
None.
Data Members
- cbSize
- The size in bytes of the structure.
- dwFlags
- Zero or more of the following flags specifying various settings and properties of SoundSentry:
- SSF_AVAILABLE
- The SoundSentry accessibility feature is available.
- SSF_INDICATOR
- Display an icon in the system tray while SoundSentry is on.
- SSF_SOUNDSENTRYON
- SoundSentry is currently on.
- iFSTextEffect
- Windows 95,98: Exactly one of the following flags specifying the visual cue to use while the user is in a full-screen text window (such as a full-screen MS-DOS window). Windows NT, 2000: Reserved -- set to 0.
- SSTF_BORDER
- Flash the screen border (the overscan area).
- SSTF_CHARS
- Flash the characters in the corners of the screen.
- SSTF_DISPLAY
- Flash the entire display.
- SSTF_NONE
- Do not display a visual cue.
- iFSTextEffectMSec
- Windows 95, 98: The length of time in milliseconds to display the visual cue while in full-screen text mode. Windows NT, 2000: Reserved -- set to 0.
- iFSTextEffectColorBits
- Windows 95, 98: The RGB value of the color to use for the visual cue while in full-screen text mode. Windows NT, 2000: Reserved -- set to 0.
- iFSGrafEffect
- Windows 95, 98: Exactly one of the following flags specifying the visual cue to display while the user is in a full-screen graphics window. Windows NT, 2000: Reserved -- set to 0.
- SSGF_DISPLAY
- Flash the entire display.
- SSGF_NONE
- Do not display a visual cue.
- iFSGrafEffectMSec
- Windows 95, 98: The length of time in milliseconds to display the visual cue while in full-screen graphics mode. Windows NT, 2000: Reserved -- set to 0.
- iFSGrafEffectColor
- Windows 95, 98: The RGB value of the color to use for the visual cue while in full-screen graphics mode. Windows NT: Reserved -- set to 0.
- iWindowsEffect
- Exactly one of the following flags specifying the visual cue to use while not in full-screen mode:
- SSWF_CUSTOM
- Windows 95, 98: Call the SoundSentryProc callback function exported by the .dll file specified by lpszWindowsEffectDLL.
- SSWF_DISPLAY
- Flash the entire display.
- SSWF_NONE
- Do not display a visual cue.
- SSWF_TITLE
- Flash the title bar of the active window.
- SSWF_WINDOW
- Flash the entire active window.
- iWindowsEffectMSec
- Windows 95, 98: The length of time in milliseconds to display the visual cue while not in full-screen mode. Windows NT, 2000: Reserved -- set to 0.
- lpszWindowsEffectDLL
- Windows 95, 98: The filename of the .dll file exporting the SoundSentryProc callback function to use, if applicable. Windows NT, 2000: Reserved.
- iWindowsEffectOrdinal
- Reserved -- set to 0.
Constant Definitions
Const SSF_AVAILABLE = &H2
Const SSF_INDICATOR = &H4
Const SSF_SOUNDSENTRYON = &H1
Const SSTF_BORDER = 2
Const SSTF_CHARS = 1
Const SSTF_DISPLAY = 3
Const SSTF_NONE = 0
Const SSGF_DISPLAY = 3
Const SSGF_NONE = 0
Const SSWF_CUSTOM = 4
Const SSWF_DISPLAY = 3
Const SSWF_NONE = 0
Const SSWF_TITLE = 1
Const SSWF_WINDOW = 2
Used By
SystemParametersInfo
Go back to the alphabetical Structure listing.
Go back to the Reference section index.
Last Modified: August 15, 1999
This page is copyright © 1999 Paul Kuliniewicz.
Copyright Information Revised October 29, 2000
Go back to the Windows API Guide home page.
E-mail: vbapi@vbapi.com Send Encrypted E-Mail
This page is at http://www.vbapi.com/ref/s/soundsentry.html