AlarmEnableTag

Enables 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 AlarmEnableTag(STRING Tag [, STRING ClusterName [, INT bAcknowledge]])

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.

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 successful, otherwise an error code is returned.

Related Functions

AlarmAckTag, AlarmDisableTag, AlarmClearTag

Example

// Enable alarm and enforce acknowledgment
AlarmEnableTag("ALARM_1", "Cluster1", 1);

See Also

Alarm Functions