AlarmHornEnabled Subroutine

Gets or sets the alarm horn enabled status.

Syntax

AlarmHornEnabled ([blnNewValue], [intErrorMode])

Properties

The AlarmHornEnabled subroutine syntax has these parts:

Part

Description

blnNewValue

Boolean. (Optional). The value to which you want to set the alarm horn enable property.

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 horn will sound on any new alarm.

False = The horn will not sound for any new alarms.

 

Example