AlmBrowseEnable

The AlmBrowseEnable function enables the alarm tag 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 AlmBrowseEnable(INT iSession [, INT bAcknowledge])

iSession:

The handle to a browse session previously returned by an AlmBrowseOpen 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

AlmBrowseAck AlmBrowseDisable, AlmBrowseClose, AlmBrowseFirst, AlmBrowseGetField, AlmBrowseNext, AlmBrowseOpen, AlmBrowsePrev

Example

// Retrieve the handle to a browse session returned by an AlmBrowseOpen call.
// ...
//Enable the associated alarm and enforce acknowledgment
AlmBrowseEnable(iSession, 1);

See Also

Alarm Functions