AlmSummaryDeleteAll
The AlmSummaryDeleteAll function deletes every record from the filtered list source.
This function is a blocking function. It blocks the calling Cicode task until the operation is complete.
Syntax
AlmSummaryDeleteAll(iSession)
iSession:
The handle to a filtered list previously returned by a AlmSummaryOpen call.
Return Value
0 (zero) if the alarm filtered list session exists, otherwise an error is returned.
Related Functions
AlmSummaryAck, AlmSummaryClear, AlmSummaryClose, AlmSummaryCommit, AlmSummaryDelete, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSummaryPrev, AlmSummarySetFieldValue
Example
INT errorCode = 0;
...
errorCode = AlmSummaryDeleteAll(iSession);
IF errorCode = 0 THEN
// Successful case
ELSE
// Function returned an error
END
...
See Also