Omron CX-Supervisor 3.1, Reference Manual

Page: 16 / 22

AlarmMngt SECTION 3 Class Reference
15
3-3 AlarmMngt
Allows the client to view alarm state and history and acknowledge active
alarms.
3-3-1 ListAlarmGroups
Retrieves a list of all the alarm groups contained within a CX-Supervisor
application.
ListAlarmGroups(ByRef pGroups As Object)
3-3-2 ListAlarms
Retrieves a list of all the alarm contained within the given alarm group.
ListAlarms(ByVal szName As String, ByRef pAlarms As
Object)
3-3-3 GetAlarmData
Retrieves the metadata of a specific alarm.
GetAlarmData(ByVal szName As String, ByRef pType As
Object, ByRef pAuto As Integer, ByRef pDescription As
Object, ByRef pPriority As Object, ByRef pStatus As
Object, ByRef pDateTime As Object, ByRef pMessage As
Object)
Parameters Description
pGroups Receives an array of strings representing the names of all the
alarm groups
Parameters Description
szName Name of Alarm Group
pAlarms Receives an array of strings representing the names of all the
alarms
Parameters Description
szName Name of the Alarm
pType The type of Alarm “simple”, “deadband”, ”rateofchange”
pAuto Indicates Automatically acknowledged
pDescription The description of the alarm
pPriority The priority of the alarm
“Highest”, “High”, “Medium”, “Low”, “Lowest”
pStatus The current status of the alarm
“Inactive”, “Active”, “Acknowledged”
pDateTime The time and date the alarm entered it’s current state
pMessage The message shown