AlarmClearTag

Clears alarms by Tag on both the Primary and Standby Alarms Servers.

If this function is not called from a foreground task, it becomes a blocking function.

Syntax

INT AlarmClearTag(STRING Tag, [, STRING ClusterName])

Tag:

A string that identifies the alarm to acknowledge. It can be one of the following:

• An alarm tag — for example, "Fire1"

• An alarm equipment item — for example, "Motor1.AlarmFire"

Specify an empty string (" ") to match all alarm tags.

ClusterName:

The cluster where the tag resides.

Return Value

0 (zero) if successful, otherwise an error code is returned.

Related Functions

AlarmAckTag, AlarmEnableTag, AlarmDisableTag

See Also

Alarm Functions