Cicode Programming Reference > Cicode Function Categories > Alarm Functions > AlmTagsEnable

AlmTagsEnable

This command is now deprecated. Use AlmBrowseEnable function instead.

The AlmTagsEnable 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

AlmTagsEnable(INT iSession [, INT bAcknowledge])

iSession:

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

AlmTagsAck, AlmTagsClear, AlmTagsDisable, AlmTagsClose, AlmTagsFirst, AlmTagsGetField, AlmTagsNext, AlmTagsNumRecords, AlmTagsOpen, AlmTagsPrev

See Also

Published June 2018