AlarmTagFromEquipment

Returns the first tag associated with a piece of equipment.

Syntax

INT AlarmTagFromEquipment(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 in which the tag resides

Return Value

0 (zero) if successful, otherwise an error code will be returned

See Also

Alarm Functions