OpenAlarmList Function

Help Contents

Introduction

Opens a new alarm list.

Informal Syntax:

OpenAlarmList( TagName, TagIsFolder )

Formal Syntax:

OpenAlarmList( TagName:=Expression, TagIsFolder:=Expression )

Parameters

Parameter Type Description
TagName ANY_STRING The full name of the tag or folder to open alarms for. An empty string will show all alarms in the tag database.
TagIsFolder BOOL Whether the TagName parameter refers to a tag (false) or folder (true).

The OpenAlarmList function displays the alarm list in the form of a table. The exact behaviour varies according to the context:

A program or script will not execute any statements after the OpenAlarmList call.

Return value

None.

Examples

Displays all alarms from the tag database:

OpenAlarmList( "", TRUE );

Displays all alarms for all tags in the folder called 'Tank Control':

OpenAlarmList( "Tank Control", TRUE );

Further Information

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.