AlmSummaryDelete

The AlmSummaryDelete function deletes the record in the filtered list that the cursor is currently referencing. The cursor moves to the next available entry in the data browse session after the current alarm summary is deleted.

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 for more information.

Syntax

INT AlmSummaryDelete(LONG iSession)

iSession:

The handle to a filtered list previously returned by a AlmSummaryOpen call.

Return Value

0 (zero) if the alarm browse session exists, otherwise an error code is returned.

Related Functions

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

Example

INT errorCode = 0;

...

errorCode = AlmSummaryDelete(iSession);

IF errorCode = 0 THEN

// Successful case

ELSE

// Function returned an error

END

...

See Also

Alarm Functions