TagRemoveForce Function

Help Contents

Introduction

Removes any forced value on a tag using the RemoveForce Tag Command.

Functions and Function Blocks

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

If you want to remove a force from a tag from a Program Tag, running on the SCADA Server, use the TagRemoveForceFB Function Block.

Syntax

Informal Syntax:

TagRemoveForce( TagName )

Formal Syntax:

TagRemoveForce( TagName:=Expression )

Parameters

ParameterTypeDescription
TagNameANY_STRINGThe full name of the tag.

The TagRemoveForce Function sends the RemoveForce Tag Command to the database tag.

Return Value

None.

Examples

Removes the forced value from the tag "Storage.StartPump" using the RemoveForce Tag Command.

TagRemoveForce( "Storage.StartPump" );

Further Information

RemoveForce Tag Command

To learn about the RemoveForce Tag Command.

TagRemoveForceFB Function Block

To learn how to remove a force from a tag 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.