AlmTagsDisable

Note: This command is now deprecated. Use AlmBrowseDisable function instead.

The AlmTagsDisable function disables 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 AlmTagsDisable(INT iSession [, INT EndTime [, STRING Comment]] )

iSession:

The handle to a browse session previously returned by a AlmTagsOpen call.

EndTime:

A date/time variable that indicates when the alarm will no longer be disabled. If this parameter is omitted or set to 0, the alarm will be disabled indefinitely.

Comment:

An optional comment limited to 200 characters explaining why the alarm is disabled. If the comment exceeds 200 characters, hardware error 274 ("Invalid argument passed") will be displayed.

Return Value

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

Related Functions

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

See Also

Alarm Functions