TextDocFromTagFile Function

Help Contents

Introduction

The TextDocFromTagFile Function creates a TextDocument object from a file associated with a database tag.

Functions and Function Blocks

The TextDocFromTagFile 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 create a text document from a database tag file in a Program Tag, use the TextDocFromTagFile Function Block.

Syntax

Informal Syntax:

TextDocFromTagFile( TagName, FileType )

Formal Syntax:

TextDocFromTagFile( 
        TagName:=Expression,
        FileType:=Expression )

Parameters

The TextDocFromTagFile Function has these parameters:

Parameter Type Description
TagName ANY_STRING The full name of the database tag to read the file from.
FileType ANY_STRING The type of file to read from the database tag.

Return Value

The function returns a DINT value representing the TextDocument Object created from the tag file.

Remarks

The TextDocFromTagFile Function is only available to IEC 61131-3 code in Operator Actions.

To create a TextDocument object in an IEC 61131-3 Program Tag, use the TextDocFromTagFile Function Block.

Examples

Further Information

TextDocument Functions

For information about functions to manage TextDocument data objects.

Data Objects

For information about all Data Objects supported by Fernhill SCADA.

IEC 61131-3

To learn how IEC 61131-3 is used in Fernhill SCADA.

Glossary

For the meaning of terms used in Fernhill SCADA.