WinAlarm: Difference between revisions

Revision as of 19:26, 1 February 2017

Generates an audible alarm.

Syntax

WinAlarm(desktopHandle, alarmStyle)

Parameters

desktopHandle - HWND - input: The desktop handle.
alarmStyle - ULONG - input: The alarm style to be.

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

Cdecl32

Example Code

...
APIRET rc;
rc = WinAlarm (HWND_DESKTOP, WA_NOTE);
...

Related Functions

WinFlashWindow
WinMessageBox

Notes

WinAlarm function also used for multimedia subsystem notification.

@@ Line 1: / Line 1: @@
-== WinAlarm ==
+Generates an audible alarm.
-; WinAlarm(desktopHandle, alarmStyle) : Generates an audible alarm.
+== Syntax ==
+ WinAlarm(desktopHandle, alarmStyle)
 === Parameters ===
-; desktopHandle - [[HWND]] - input : The desktop handle.
+;desktopHandle - [[HWND]] - input : The desktop handle.
-; alarmStyle - [[ULONG]] - input : The alarm style to be.
+;alarmStyle - [[ULONG]] - input : The alarm style to be.
 === Constants ===
 These are the differing alarm tone constants:
-* [[WA_WARNING]]
+*WA_WARNING
-* [[WA_NOTE]]
+*WA_NOTE
-* [[WA_ERROR]]
+*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.
-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 ===
@@ Line 19: / Line 20: @@
 * [[FALSE]]
-Possible errors from [[OS2 API:WinGetLastError|WinGetLastError]] are:
+Possible errors from [[WinGetLastError]] are:
 * [[OS2 API:PMI:error#PM_INVALID_HWND|PM_INVALID_HWND]]
 * [[OS2 API:PMI:error#PM_INVALID_PARAM|PM_INVALID_PARAM]]
@@ Line 38: / Line 39: @@
   ...
-=== Related Functions ===
+==Related Functions==
-[[WinFlashWindow]]
+*WinFlashWindow
-[[WinMessageBox]]
+*[[WinMessageBox]]
-=== Notes ===
+==Notes==
 [[WinAlarm]] function also used for multimedia subsystem notification.
 [[Category:Win]]