The AlmSummaryClear function clears the latched alarm at the current cursor position in an active data browse session. A latched alarm is an alarm which is OFF and acknowledged when [Alarm]AckHold is set to 1. The function does nothing if the alarm summary entry at the cursor is not linked to a latched alarm.
This function is a non-blocking function. It does not block the calling Cicode task.
Syntax
INT AlmSummaryClear(LONG Session)
Session:
The handle to a browse session previously returned by a AlmSummaryOpen call.
Return Value
0 (zero) if the alarm browse session exists, otherwise an error code is returned.
Related Functions
AlmSummaryAck, AlmSummaryClose, AlmSummaryDelete, AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSummaryPrev, AlmSummaryNumRecords
See Also
Published June 2018