AlarmAck

Acknowledges alarms. You can acknowledge 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.

Note: This function cannot be used with StruxureWare templates.

This command takes the currently logged in user into account. In other words, only the alarms that the user can see are acknowledged.

Note: This function will only work while the record is writable which is controlled by the ArchiveAfter Parameter. Refer to the topic Configure the Archiving Parameters in the main help for more information.

You would normally call this function from a keyboard command. No action is taken if the specified alarms have already been acknowledged.

Note:Alarm commands on single clusters will return either 0 if successful or an error code if unsuccessful. Alarm commands across multiple clusters may also return a partial success result, whereby a command has been successful on 'at least' one cluster but unsuccessful on another cluster.

If this function is not called from a foreground task, it becomes a blocking function.

Syntax

INT AlarmAck(INT Mode, INT Value [, STRING ClusterName])

Mode:

The type of acknowledgment:

0 - Acknowledge a single alarm.

• Set Value to the AN where the alarm is displayed.
• If Value is set to 0, the current cursor position will be used.

1 - Acknowledge 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 acknowledge the (displayed) alarm list (on the active page) where the cursor is positioned.
• Set Value to -1 to acknowledge all (displayed) alarm lists on the active page.This only applies to alarm lists created using AlarmDsp (and not those created using AlarmDspLast).

2 - Acknowledge a category of alarms:

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

3 - Acknowledge alarms of a specific priority.

• Set Value to the alarm priority (0-255) of the alarms to be acknowledged. Alarm priority 0 indicates all priorities.
  Hardware alarms are not affected by priority.
  Set Value to the group handle to acknowledge a group of alarms of different priorities.

Note:Alarm Summary page no longer supports Modes 1, 2, and 3.

Value:

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

sClusterName:

Used with Mode 2 or 3 to specify the name of the cluster in which the alarms being acknowledged reside. 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 code will return

Note: In some cases this function is non-blocking. Under these circumstances, any error that is detected when the alarm server processes the command will not be returned.

Related Functions

GrpOpen

Example

! Acknowledge alarms of the specified group of categories.
FUNCTION
AckGrp(STRING CategoryGroup)
    INT hGrp;
    hGrp=GrpOpen("CatGroup",1);
    StrToGrp(hGrp,CategoryGroup);
    AlarmAck(2,hGrp, "clusterXYZ");
    GrpClose(hGrp);
END

See Also

Alarm Functions

Published June 2018