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.
Note: This function will only work while the record is writable which is controlled by the ArchiveAfter Parameter. Refer to the topic Configure the Archiving Parameters in the main help for more information.
Syntax
INT AlmSummaryDeleteAll(LONG 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 code is returned.
Related Functions
AlmSummaryAck, AlmSummaryClear, AlmSummaryClose, AlmSummaryDelete, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSummaryPrev, AlmSummaryNumRecords
Example
INT errorCode = 0;
...
errorCode = AlmSummaryDeleteAll(iSession);
IF errorCode = 0 THEN
// Successful case
ELSE
// Function returned an error
END
...
See Also
Published June 2018