TagAlarmPropertyRestore Function

Help Contents

Introduction

The TagAlarmPropertyRestore Function allows an operator to restore the value property of an Data Point Alarm Tag back to its configured value.

The function requests the property change using the AlarmPropertyRestore Tag Command. Code execution is suspended until the tag command completes.

Functions and Function Blocks

The TagAlarmPropertyRestore 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.

There is currently no equivalent function block available.

Syntax

Informal Syntax:

TagAlarmPropertyRestore( TagName, PropertyName, NewValue )

Formal Syntax:

TagAlarmPropertyRestore( 
        TagName:=Expression, 
        PropertyName :=Expression,
        NewValue := Expression )

Parameters

ParameterTypeDescription
TagNameANY_STRINGThe full name of the tag.
PropertyNameANY_STRINGThe property of the alarm to override.
NewValueANY_ELEMENTARYThe new property value.

Return Value

None.

Remarks

The TagAlarmPropertyRestore Function sends the AlarmPropertyRestore Tag Command to a database tag.

The user must have the TuneAlarm privilege for the database tag.

Further Information

AlarmPropertyRestore Tag Command

To learn about the AlarmPropertyRestore Tag Command.

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.