AlarmDspLast
Displays the latest unacknowledged alarms, at a specified AN with the cluster named. Use this function to display the last alarms. You can specify the number of alarms to display of a specified type, for example, active hardware alarms or disabled non-hardware alarms.
Syntax
AlarmDspLast(AN [, Count] [, Type] [, ClusterName] [, iNoDraw] [, sCallbackFunc] )
AN:
Note: The [Animator]MaxAn citect ini parameter sets the maximum AN which AlarmDspLast will work with.
The AN where the last alarms are to be displayed.
Count:
The number of alarms to display. If you omit the Count, the default is 1.
Type:
The type of alarms to display:
Non-hardware alarms
0 - All active alarms, that is Types 1 and 2
1 - All unacknowledged alarms, ON and OFF
2 - All acknowledged ON alarms
3 - All disabled alarms
4 - All configured (non-hardware) alarms, that is Types 0 to 3, plus acknowledged OFF alarms.
Hardware alarms
5 - All active alarms, that is Types 6 and 7
6 - All unacknowledged alarms, ON and OFF
7 - All acknowledged ON alarms
8 - All disabled alarms
9 - All configured alarms, that is Types 5 to 8
Alarm Summary
10 - All summary alarms
Alarm General
11 - All ON alarms
12 - All OFF alarms
13 - All ON hardware alarms
14 - All OFF hardware alarms
If you omit the Type, the default is 1.
ClusterName:
The cluster name to which the alarms belong. This is optional if you have one cluster or are resolving the alarm server via the current cluster context. The argument is enclosed in quotation marks "".
If a cluster name is not specified, alarms are returned for all clusters.
iNoDraw:
Makes call to Alarm Server to update the ALMCB but does not automatically perform the animation of the data when the result is returned.
sCallbackFunc:
Callback function to associate with the return of the ALMCB data from the Alarm Server.
Return Value
0 (zero) if successful, otherwise an error is returned.
Related Functions
Example
|
Advanced Animation |
|
|
Command |
AlarmDspLast(11, 'ClusterXYZ') |
|
Comment |
Display the last alarm at AN 11 |
|
Advanced Animation |
|
|
Command |
AlarmDspLast(21,3, 'ClusterXYZ') |
|
Comment |
Display the last 3 alarms at AN 21 |
See Also