(Alarm Manager module)
| Description | This subroutine is used to turn off alarms sounds for all alarms, both current and future. |
| Returns | Numeric |
| Usage | Script |
| Function Groups | Alarm, Speech and Sound |
| Related to: | |
Format:  |
\AlarmManager\MuteSound([Invalid, MuteState, ExpiryTime]); |
| Parameters | None. |
| Invalid |
| Placeholder. This parameter is now obsolete. |
| MuteState |
| Optional Boolean. Set TRUE to mute sound or FALSE to unmute. Defaults to TRUE. |
| ExpiryTime |
| Optional numeric. Time at which a muted alarm should unmute (UTC). Leave empty to toggle alarm muting immediately according to the MuteState setting. |
| Comments |
This subroutine will check the current user session to ensure that the logged-on user has the required privilege to toggle alarm muting before proceeding.
The alarm Mute button can be selected or released for each individual user or for computers in the network, according to application configuration. See: |
Example:
IF AlarmShouldBeMuted; [ \AlarmManager\MuteSound(); ]
