AlarmDelete

Deletes alarm summary entries that are currently displayed. You can delete 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.

Syntax

AlarmDelete(Mode, Value [, ClusterName] )

Mode:

The type of deletion:

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

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

1 - Delete 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 delete the (displayed) alarm list (on the active page) where the cursor is positioned.
• Set Value to -1 to delete every (displayed) alarm list on the active page.

2 - Delete a category of alarms.

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

3 - Delete alarms of a specific priority.

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

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

Value:

Used with Mode 1 or 2 to specify which alarms to delete.

ClusterName:

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

Return Value

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

Related Functions

GrpOpen

Example

System Keyboard
Key Sequence	DelSum
Command	AlarmDelete(0, 0)
Comment	Delete the alarm summary entry where the cursor is positioned
System Keyboard
Key Sequence	ShiftDelSum
Command	AlarmDelete(1, -1)
Comment	Delete a page of alarm summary entries
System Keyboard
Key Sequence	SumDelete ### Enter
Command	AlarmDelete(2, Arg1, "clusterXYZ")
Comment	Delete alarm summary entries of a specified category in cluster XYZ
System Keyboard
Key Sequence	DelSum ############# Enter
Command	AlarmDelete(3,Arg1, "clusterXYZ")
Comment	Delete alarm summary entries of a specified priority in cluster XYZ

See Also

Alarm Functions