AlarmHornEnabledToggle Subroutine

Toggles the system's AlarmHornEnabled status.

Syntax

AlarmHornEnabledToggle ([intErrorMode])

Properties

The AlarmHornEnabledToggle subroutine syntax has this part:

Part	Description
intErrorMode	Integer. (Optional). The error mode. 0 (default) – Errors are displayed in the form of a message box. 1 – Errors are not handled so that they can be handled in the calling routine. 2 – Errors are dispatched to the alarm destinations using SendOperatorMessage.

Return Value

Boolean. The status of the AlarmHornEnable after the call is completed.

True = The status was toggled to True. The horn will sound on any new alarm.

False = The status was toggled to False. The horn will not sound for any new alarms.

 

Example