AlarmDisableRec

Disables alarms by record number on both the Primary and Standby Alarms Servers. This function can be called from Alarm Server or Client and should not be used with a MsgRPC() call to the Alarm Server.

Syntax

AlarmDisableRec(Record [, ClusterName] )

Record:

The alarm record number, returned from any of the following alarm functions:

• AlarmFirstCatRec() or AlarmNextCatRec() - used to search for a record by alarm category, area, and type (acknowledged, disabled, etc.).
• AlarmFirstPriRec() or AlarmNextPriRec() - used to search for a record by alarm priority, area, and type (acknowledged, disabled, etc.).
• AlarmFirstTagRec() or AlarmNextTagRec() - used to search for a record by alarm tag, name, and description.
• AlarmGetDsp() - used to find the record that is displayed at a specified AN, for either an alarm list or alarm summary entry. Set the sField argument in AlarmGetDsp() to "RecNo".

To store this value, use data type Int in Cicode or Long for variable tags (Long needs 4 bytes).

ClusterName:

Specifies the name of the cluster in which the Alarm Server resides. This is optional if you have one cluster or are resolving the alarm server via the current cluster context. The argument is enclosed in quotation marks "".

Return Value

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

Related Functions

AlarmFirstTagRec, AlarmNextTagRec, AlarmDisable, MsgRPC

Example

/* Disable/enable the specified "Pump" alarm. Flag determines 
whether the alarm is disabled (Flag=0) or enabled (Flag=1). */

FUNCTION

DisablePumps(STRING sTag, INT Flag)

	 INT Current;

	INT Next;

 Current=AlarmFirstTagRec(sTag,"Pump","");

 WHILE Current<>-1 DO

				Next=AlarmNextTagRec(Current,sTag,"Pump","");

			 IF Flag=0 THEN

					AlarmDisableRec(Current);

		 ELSE

					AlarmEnableRec(Current);

		END

			 Current=Next;

	 END

END

See Also

Alarm Functions