Creates an alarms list at a specified AN.
Syntax
INTAlarmListCreate(INT nAN, INT alarm_type, INT width, INT height, INT rowheight, INT drawheader [, STRING sCluster [, STRING sFormat [, INT hFontRow [, INT hFontHeader]]]])
nAN:
The AN number to associate with the alarms list.
alarm_type:
The type of alarms to display in the alarms list:
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.
Alarm Summary
10 - All summary alarms
15 – Sequence of events with configuration events filtered out
16 - Sequence of events
Alarm General
11 - All ON alarms
12 - All OFF alarms
17 - All unacknowledged ON alarms
18 - All unacknowledged OFF alarms
width:
The width of the area in which the alarms list will display (in pixels).
height:
The height of the area in which the alarms list will display (in pixels).
rowheight:
The height of each row in the alarms list (in pixels).
drawheader:
Determines if the alarms list includes a header row. You need to enter a value; there is no default.
sCluster:
Specifies the cluster context for the alarms displayed in the list. This value is optional. If not specified, it defaults to all clusters.
sFormat:
The name of the display format applied to the alarms list. This determines the arrangement of columns that are presented. A customized name can be defined for a display format using the parameter [Format]FormatName.
This value is optional. If not specified, the default format for the type of alarm specified in the alarm_type parameter is used.
hFontRow:
The handle for the font you would like to use in the alarm list rows. This value is optional. If not specified, it defaults to –1 (the default font).
Font handles are generated by the Cicode function DspFont.
hFontHeader:
The handle for the font you would like to use in the alarm list header row. This value is optional. If not specified, it defaults to –1 (the default font).
Font handles are generated by the Cicode function DspFont.
Return Value
0 (zero) if successful, otherwise an error code is returned. The error code can be obtained by calling the IsError Cicode function.
Related Functions
AlarmListDisplay, AlarmListDestroy
See Also
Published June 2018