Description: This subroutine is used to turn off alarms sounds for all alarms, both current and future.
Format: MuteSound();
Parameters: None.
Comments: This subroutine will toggle the mute setting.
This subroutine always returns "1".
The configuration file setting AlmMuteAllow must be set to a numeric value for the mute setting to be communicated to all computers on the network. Any workstation that has an AlmMuteAllow value greater than or equal to the value set on the workstation executing the code will toggle the mute flag. Information on the AlmMuteAllow value can be found in Config.ini [SYSTEM] Section Variables for Alarms.
Note: In VTS versions 6.50 and later, the alarm Mute button can be selected or released for each individual user, according to their preference. There is a variable called "Mute" for each user, which is held in the AlarmPlayer() module for each user. The new variable is not persistent, so that the state of the Mute button is no longer remembered between starts of the application. A configuration file variable called MuteAlarms is used to initialize the state of the Mute button for each user at the start of the user's session. Information on MuteAlarms can be found in Config.ini [SYSTEM] Section Variables for Alarms.
There are actually parameters to this subroutine, but their use will cause the subroutine to malfunction.