This function acknowledges an active alarm on
the specified tag. The advantage of using this function is that if
used from the Thin Client, the Alarm task will store the user name
and station from which the alarm was acknowledged.
|
Function |
Group |
Execution |
Windows |
Embedded |
Thin Client |
| ExecuteAlarmAck
|
Tags
Database |
Synchronous |
Supported |
Supported |
Supported |
Syntax
ExecuteAlarmAck( "strTagName", optStrComment, optStrAlarmType )
- strTagName
- Name of the tag on which the alarm will be
acknowledged.
Note: The tag
name must be enclosed in quotes, as shown in the syntax diagram, or
else the project will try to get the value of the named
tag.
- optStrComment
- An optional comment to send to the Alarm task, along
with the user name and station.
- optStrAlarmType
- If more than one alarm is active on the specified
tag, you can specify which alarm (e.g., Hi, Lo, HiHi, LoLo) to
acknowledge. Otherwise, the function acknowledges the most recently
activated alarm.
Returned value
| Value |
Description |
| 0
|
Successfully executed. |
| -1
|
Invalid number of parameters. |
| -2
|
Invalid tag name. |
Examples
|
Tag Name |
Expression |
|
Tag |
ExecuteAlarmAck ("a","Hi alarm in tag
a","Hi") // Returned value = 0 if successfully executed |