AlarmDisableTag

Disables 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 AlarmDisableTag(STRING Tag, [, STRING ClusterName] [, INT EndTime [, STRING Comment]]] )

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.

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

Related Functions

AlarmAckTag, AlarmEnableTag, AlarmClearTag

Example

// Disable alarm for the next 60 minutes
nEndTime = DateAdd(TimeCurrent(), 3600);
AlarmDisableTag("ALARM_1", "Cluster1", nEndTime, "Shelve alarm for 60 minutes.");

// Disable alarm until 20 Dec 2016 6:30am local time
nEndTime = DateAdd(StrToDate("20/12/2016"), StrToTime("6:30"));
AlarmDisableTag("ALARM_1", "Cluster1", nEndTime, "Shelve alarms until 20 Dec 2016 6:30am");

See Also

Alarm Functions