Cicode Programming Reference > Cicode Function Categories > Alarm Functions Introduction > 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. To change the appearance of a summary entry to acknowledged without sending an acknowledge message to the active alarm list set the acknowledged time using the AlmSummarySetFieldValue() function.

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

Syntax

AlmSummaryAck(iSession)

iSession:

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 is returned.

Related Functions

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

See Also

Alarm Functions