OS2 API:WinAlarm

From EDM2

Contents 1 WinAlarm 1.1 Parameters 1.2 Constants 1.3 Returns 1.4 Module 1.5 Define (C/C++) 1.6 Ordinal/Export name 1.7 Calling conversion 1.8 Example Code 1.9 Related Functions 1.10 Notes 1.11 OS Version Introduced

[edit] WinAlarm

WinAlarm(desktopHandle, alarmStyle) 

Generates an audible alarm.

[edit] Parameters

desktopHandle - HWND - input 

The desktop handle.

alarmStyle - ULONG - input 

The alarm style to be.

[edit] 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.

[edit] Returns

This function returns a BOOL with the values of:

• TRUE
• FALSE

Possible errors from WinGetLastError are:

• PM_INVALID_HWND
• PM_INVALID_PARAM

[edit] Module

DOSCALLS

[edit] Define (C/C++)

INCL_WINDIALOGS or INCL_WIN or INCL_PM or INCL_COMMON

[edit] Ordinal/Export name

[edit] Calling conversion

Cdecl32

[edit] Example Code

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

[edit] Related Functions

WinFlashWindow WinMessageBox

[edit] Notes

WinAlarm function also used for multimedia subsystem notification.

[edit] OS Version Introduced