Cicode Programming Reference > Cicode Function Categories > Alarm Functions > AlmSummaryAck

AlmSummaryAck

The AlmSummaryAck function acknowledges the alarm in the active alarm list which is linked to the current entry of the alarm summary browse session.

If the current alarm summary browse session entry is a user event the function will have no effect.

This function is a non-blocking function. It does not block the calling Cicode task.

Syntax

INT AlmSummaryAck(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

AlmSummaryClear, AlmSummaryClose, AlmSummaryDelete, AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSummaryPrev, AlmSummaryNumRecords

See Also

Alarm Functions

Published June 2018