The AlmSummaryEnable function enables 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
INT AlmSummaryEnable(INT iSession [, INT bAcknowledge])
iSession:
The handle to a browse session previously returned by an AlmSummaryOpen call.
bAcknowledge:
Forces acknowledgment of an alarm after it is enabled. The accepted values are:
0 — (default) enforced acknowledgment will not be applied.
1 — alarm will be acknowledged when enabled.
Return Value
0 (zero) if the alarm browse session exists, otherwise an error code is returned.
Related Functions
AlmSummaryAck, AlmSummaryClear, AlmSummaryClose, AlmSummaryDelete, AlmSummaryDeleteAll, AlmSummaryDisable, AlmSummaryFirst, AlmSummaryGetField, AlmSummaryLast, AlmSummaryNext, AlmSummaryOpen, AlmSummaryPrev, AlmSummaryNumRecords
Example
// Retrieve the handle to a browse session returned by an AlmSummaryOpen call. // ... //Enable the associated alarm and enforce acknowledgment AlmSummaryEnable(iSession, 1);
See Also
Published June 2018