AlarmSumType

This command is deprecated in this version of CitectSCADA. Use the AlmSummary commands instead.

Retrieves a value that indicates a specified alarm's type, that is whether it's a digital alarm, an analog alarm, hardware alarm, etc.

This function can only be used if the Alarm Server is on the current machine. When the Alarm Server is not in the calling process, this function will become blocking and cannot be called from a foreground task. In this case, the return value will be undefined and a Cicode hardware alarm will be raised.

Syntax

AlarmSumType(Index [, ClusterName] )

Index:

The alarm summary index (returned from the AlarmSumFirst(), AlarmSumNext(), AlarmSumLast(), AlarmSumPrev(), AlarmSumAppend(), or AlarmSumFind() function).

ClusterName:

Specifies the name of the cluster in which the Alarm Server resides. 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 "".

Return Value

A number that represents one of the following alarm types:

• 0 = digital alarm
• 1 = analog alarm
• 2 = advanced alarm
• 3 = Multi-Digital alarm
• 4 = Argyle analog alarm
• 5 = user-generated event
• 6 = high resolution alarm
• 8 = time-stamped digital alarm
• 9 = time-stamped analog alarm
• -1 indicates an invalid response to the request.

Related Functions

AlarmSumGet, AlarmSumFirst, AlarmSumNext, AlarmSumLast, AlarmSumPrev, AlarmSumFind, AlarmSplit

See Also

Alarm Functions