Cicode Programming Reference > Cicode Function Categories > Alarm Functions Introduction > AlarmSumPrev


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

Gets the index of the previous alarm summary entry, that is, the entry that occurred before the entry specified by Index. You can use this index in the AlarmSumGet() function to get field data from an alarm record, in the AlarmSumSet() function to change the existing data in that record, or in the AlarmSumDelete() function to delete the record.

You can use this function to work with a series of alarm summary records. Call the AlarmSumLast() or AlarmSumFind() function to get the index, and then call AlarmSumPrev() within a loop, to move backwards in the alarm summary.

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.


AlarmSumPrev(Index [, ClusterName] )


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


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

0 (zero) if the alarm summary entry exists, otherwise an error is returned.

Related Functions

AlarmSumGet, AlarmSumSet, AlarmSumDelete, AlarmSumFirst, AlarmSumNext, AlarmSumLast, AlarmSumFind


See AlarmSumLast.

See Also

Alarm Functions