The AlmSummaryCommit function triggers the actual write of the value for the field previously specified by AlmSummarySetFieldValue.
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
AlmSummaryCommit(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, AlmSummaryClear, AlmSummaryClose, AlmSummaryDelete, AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryEnable, AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSummaryPrev, AlmSummarySetFieldValue
Example
INT errorCode = 0;
...
errorCode = AlmSummaryCommit(iSession);
IF errorCode = 0 THEN
// Successful case
ELSE
// Function returned an error
END
...
See Also
Published June 2018