TagAcknowledgeAlarms Function

Help Contents

Introduction

The TagAcknowledgeAlarms Function acknowledges the alarms associated with an Alarm Tag.

The function acknowledges alarms using the AcknowledgeAlarms Tag Command. Code execution is suspended until the tag command completes.

Functions and Function Blocks

The TagAcknowledgeAlarms Function is intended for use in an Operator Action. Operator Actions run in response to user input gestures in the Operator Interface. In an Operator Action, code execution is suspended until the function completes.

To acknowledge alarms from a Program Tag, running on the SCADA Server, use the TagAcknowledgeAlarmsFB Function Block.

Syntax

Informal Syntax:

TagAcknowledgeAlarms( TagName, Comment )

Formal Syntax:

TagAcknowledgeAlarms( 
        TagName:=Expression, 
        Comment:=Expression )

Parameters

ParameterTypeDescription
TagNameANY_STRINGThe full name of the tag.
CommentANY_STRINGThe comment to associate with the acknowledgement.

Return Value

None.

Remarks

The TagAcknowledgeAlarms Function sends the AcknowledgeAlarms Tag Command to a database tag.

The user must have the Acknowledge Alarms privilege for the database tag.

Further Information

AcknowledgeAlarms Tag Command

To learn about the AcknowledgeAlarms Tag Command.

TagAcknowledgeAlarmsFB Function Block

To learn how to acknowledge alarms from a Program Tag.

Operator Actions

To learn where you can use this function.

Structured Text Function Call

To learn about calling a function from IEC 61131-3 structured text.

IEC 61131-3 Expressions

To learn about the different types of expression to use as function parameters.

Glossary

For the meaning of terms used in Fernhill SCADA.