WinAlarm: Difference between revisions
No edit summary |
m →Returns |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 5: | Line 5: | ||
== Parameters == | == Parameters == | ||
;desktopHandle | ;desktopHandle ([[HWND]]) - input : The desktop handle. | ||
;alarmStyle | ;alarmStyle ([[ULONG]]) input : The alarm style to be. | ||
== Constants == | == Constants == | ||
| Line 17: | Line 17: | ||
== Returns == | == Returns == | ||
This function returns a [[BOOL]] with the values of: | This function returns a [[BOOL]] with the values of: | ||
* | *TRUE | ||
* | *FALSE | ||
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 == | == Module == | ||
| Line 40: | Line 39: | ||
==Related Functions== | ==Related Functions== | ||
*WinFlashWindow | *[[WinFlashWindow]] | ||
*[[WinMessageBox]] | *[[WinMessageBox]] | ||
Latest revision as of 16:34, 26 October 2025
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:
- TRUE
- FALSE
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.