OpenAlarmListEx Function

Help Contents

Introduction

Opens a new alarm list.

Syntax

Informal Syntax:

OpenAlarmListEx( Title, Columns, Filter )

Formal Syntax:

OpenAlarmListEx( Title:=Expression, Columns:=Expression, Filter:=Expression )

Parameters

Parameter Type Description
Title ANY_STRING The title to show above the alarm list. If this parameter is an empty string, no title will be shown above the list.
Columns ANY_STRING The list of columns to display in the alarm list. For information on how to use this parameter, see Alarm Column List.
Filter ANY_STRING The filter to select which alarms to include in the alarm list. For information on how to use this parameter, see Alarm Filter.

Return Value

None.

Remarks

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

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

For finer control over the columns displayed, and alarms included, us the OpenAlarmListEx() Function.

Examples

  1. Display all active, cleared and acknowledged alarms:
    OpenAlarmListEx( "All Alarms", "", "" );
  2. Display all enabled alarms with the current value:
    OpenAlarmListEx( 
        "All Alarms", 
        "Severity, Timestamp, Message, Source, Condition, State, Value", 
        "States=[Enabled]" );

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.