WinAlarm: Difference between revisions
mNo edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
WinAlarm(desktopHandle, alarmStyle) | WinAlarm(desktopHandle, alarmStyle) | ||
== Parameters == | |||
;desktopHandle | ;desktopHandle ([[HWND]]) - input : The desktop handle. | ||
;alarmStyle | ;alarmStyle ([[ULONG]]) input : The alarm style to be. | ||
== Constants == | |||
These are the differing alarm tone constants: | These are the differing alarm tone constants: | ||
*WA_WARNING | *WA_WARNING | ||
| Line 15: | Line 15: | ||
The frequency of these alarm types can be changed with '''WinSetSysValue'''. The alarm frequency range is 0x0025 through 0x7FFF. If SV_ALARM is set to [[FALSE]] then no alarm will sound. | The frequency of these alarm types can be changed with '''WinSetSysValue'''. The alarm frequency range is 0x0025 through 0x7FFF. If SV_ALARM is set to [[FALSE]] then no alarm will sound. | ||
== Returns == | |||
This function returns a [[BOOL]] with the values of: | This function returns a [[BOOL]] with the values of: | ||
* [[TRUE]] | * [[TRUE]] | ||
| Line 21: | Line 21: | ||
Possible errors from [[WinGetLastError]] are: | Possible errors from [[WinGetLastError]] are: | ||
* [[ | * [[PM Error Codes#PM_INVALID_HWND|PM_INVALID_HWND]] | ||
* [[ | * [[PM Error Codes#PM_INVALID_PARAM|PM_INVALID_PARAM]] | ||
== Module == | |||
DOSCALLS | DOSCALLS | ||
== Define (C/C++) == | |||
INCL_WINDIALOGS or INCL_WIN or INCL_PM or INCL_COMMON | INCL_WINDIALOGS or INCL_WIN or INCL_PM or INCL_COMMON | ||
== Calling Convention == | |||
[[Cdecl32]] | [[Cdecl32]] | ||
== Example Code == | |||
... | ... | ||
APIRET rc; | APIRET rc; | ||
| Line 40: | Line 40: | ||
==Related Functions== | ==Related Functions== | ||
*WinFlashWindow | *[[WinFlashWindow]] | ||
*[[WinMessageBox]] | *[[WinMessageBox]] | ||
Latest revision as of 15:14, 7 April 2024
Generates an audible alarm.
Syntax
WinAlarm(desktopHandle, alarmStyle)
Parameters
Constants
These are the differing alarm tone constants:
- WA_WARNING
- WA_NOTE
- WA_ERROR
The frequency of these alarm types can be changed with WinSetSysValue. The alarm frequency range is 0x0025 through 0x7FFF. If SV_ALARM is set to FALSE then no alarm will sound.
Returns
This function returns a BOOL with the values of:
Possible errors from WinGetLastError are:
Module
DOSCALLS
Define (C/C++)
INCL_WINDIALOGS or INCL_WIN or INCL_PM or INCL_COMMON
Calling Convention
Example Code
... APIRET rc; rc = WinAlarm (HWND_DESKTOP, WA_NOTE); ...
Related Functions
Notes
WinAlarm function also used for multimedia subsystem notification.