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

AlmSummaryClear

The AlmSummaryClear function clears the alarm at the current cursor position in an active data browse session.

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

Syntax

AlmSummaryClear(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

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

See Also

Alarm Functions