AlarmDisable

Disables alarms. You can disable the alarm where the cursor is positioned, one or more alarm lists on the active page, a whole category of alarms, or alarms of a particular priority.

You would normally call this function from a keyboard command. No action is taken if the alarms are already disabled. Use the AlarmEnable() function to re-enable an alarm.

After you disable an alarm, it does not display on the alarm page, alarm summary page, or alarm log. If you set the [Alarm]DisplayDisable parameter to 1, logging of disabled alarms continues, but the disabled alarms are not displayed on the alarm display or alarm summary pages.

Syntax

AlarmDisable(Mode, Value [, ClusterName] )

Mode:

The type of disable:

0 - Disable a single alarm where the cursor is positioned.

• Set Value to 0 (zero) - it is not used.

1 - Disable a page of alarms. AN alarm page can contain more than one alarm list:

• Set Value to the AN where the alarm list is displayed.
• Set Value to 0 to disable the (displayed) alarm list (on the active page) where the cursor is positioned.
• Set Value to -1 to disable the (displayed) alarm list on the active page.

2 - Disable a category of alarms.

• Set Value to the alarm category (0-16375) of the alarms to be disabled. Please be aware that alarm category 0 indicates all categories; alarm category 255 indicates hardware alarms.
• Set Value to the group number to disable a group of categories.

3 - Disable alarms of a specific priority.

• Set Value to the alarm priority (0-255) of the alarms to be disabled.

Alarm priority 0 indicates all priorities. Hardware alarms are not affected by priority. Set Value to the group handle to disable a group of alarms of different priorities.

Value:

Used with Mode 1 and 2 to specify which alarms to disable.

ClusterName:

Used with Mode 2 or 3 to specify the name of the cluster where the alarms being disabled reside in. This argument is optional if the client is connected to only one cluster containing an Alarm Server or are resolving the alarm server via the current cluster context.

This argument is not required where:

• the mode is 2 and the value is 255 (hardware alarm category).

This argument is enclosed in quotation marks "".

Return Value

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

Related Functions

GrpOpen, AlarmEnable, AlarmDisableRec

Example

System Keyboard
Key Sequence	Disable
Command	AlarmDisable(0, 0)
Comment	Disable the alarm where the cursor is positioned
System Keyboard
Key Sequence	ShiftDisable
Command	AlarmDisable(1, -1)
Comment	Disable a page of alarms
System Keyboard
Key Sequence	AlarmDisable ### Enter
Command	AlarmDisable(2, Arg1, "clusterXYZ")
Comment	Disable alarms of a specified category in cluster XYZ
System Keyboard
Key Sequence	DisPri ############# Enter
Command	AlarmDisable(3,Arg1,"clusterXYZ")
Comment	Disable alarms of a specific priority in cluster XYZ

See Also

Alarm Functions