TagDisableAlarms Function

Help Contents

Introduction

The TagDisableAlarms Function disables the alarms associated with an Alarm Tag.

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

Functions and Function Blocks

The TagDisableAlarms 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 disable alarms from a Program Tag, running on the SCADA Server, use the TagDisableAlarmsFB Function Block.

Syntax

Informal Syntax:

TagDisableAlarms( TagName )

Formal Syntax:

TagDisableAlarms( TagName:=Expression )

Parameters

ParameterTypeDescription
TagNameANY_STRINGThe full name of the tag.

Return Value

None.

The TagDisableAlarms Function sends the DisableAlarms Tag Command to the database tag.

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

Further Information

DisableAlarms Tag Command

To learn about the DisableAlarms Tag Command.

TagDisableAlarmsFB Function Block

To learn how to disable 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.