Scripting Guide - AlarmBanner.Alarms (Alarm Banner Functions and Properties)

AlarmBanner.Alarms

The AlarmBanner.Alarms property represents a collection of the alarms currently in the Alarm Banner. It is only available for the Alarm Banner object and so only applies to Alarm Banner scripts.

Syntax	AlarmBanner.Alarms
Description	Represents the alarms currently in the Alarm Banner in ViewX.
Arguments	None.
Returns	Alarm Collection. A collection of alarms (the alarms in the Alarm Banner). You can then access the properties of individual alarms in the collection (see Alarm Collection Properties).

Example:

In this example, the function AllAlarms calls the PrintAlarmInfo function for the alarms in the Alarm Banner. The PrintAlarmInfo function would be defined elsewhere in the script and would define what alarm information from each alarm is printed.

Function AllAlarm
- for each A in AlarmBanner.Alarms
  - PrintAlarmInfo A
- Next
End Function

The letter A represents each alarm in the collection. A is simply a variable and you can use any letter or word to represent each alarm.