OnAlarmNotification

<< Click to Display Table of Contents >>

Manual > Control Reference > Data > Remote alarm grid client control > Events >

OnAlarmNotification


 

Occurs when an alarm is generated (raised, cleared, acknowledged, or has a change of state).

 


syntax

event OnAlarmNotification(

         type,

         date,

         alarmId,

         bRecovered,

         bAcked,

         comments,

         bBrandNew

         )

 


Parameters

 

type


Type:

character


Type of alarm.

"new"        When an alarm occurs.

"recover"        -      When the alarm recovers.

"ack"        When an alarm is acknowledged.

"change"        When the alarm state changes.

 

date


Type:

time


The date and time the alarm was generated.

 

alarmId


Type:

character


The alarm ID.

 

bRecovered


Type:

Boolean


TRUE - It has recovered. FALSE - It has not recovered.

 

bAcked


Type:

Boolean


TRUE - Confirmed. FALSE - Not confirmed.

 

comments


Type:

character


All comments set in the alarm master are passed as an array.

 

bBrandNew


Type:

Boolean


This parameter is set only when the alarm summary display is started by calling the SubscribeSummary method.

The parameters mean that new alarms that occur after the server goes online will be marked T, and past alarms that occurred before the server went online will not be evaluated and will be marked F (if SubscribeSummary is called immediately after going online, this event will be generated for the number of alarms currently occurring, but all bBrandNew at that time will be marked F).

 

This parameter will be set to T for each alarm ID when it first occurs (if there were active or unacknowledged alarms before going online, alarms with the same alarm ID that occurred in the past will also be set to T).

 

 


reference