LinkedListIsEmpty Function

Help Contents

Introduction

The LinkedListIsEmpty Function tests whether a LinkedList Data Object contains no entries.

Syntax

Informal Syntax:

LinkedListIsEmpty( LinkedListID )

Formal Syntax:

LinkedListIsEmpty( 
        LinkedListID:=Expression )

Parameters

The LinkedListIsEmpty Function has these parameters.

Parameter Type Description
LinkedListID DINT The identifier of the LinkedList Data Object.

Return Value

The function returns a BOOL value as follows:

ValueDescription
FALSEThe LinkedList Data Object contains at least 1 elementary data value.
TRUEThe LinkedList Data Object is empty.

Remarks

A LinkedList Data Object is empty if it contains no entries.

The function reports a runtime error if the LinkedListID parameter does not refer to a valid LinkedList Data Object.

Standards Compliance

The LinkedListIsEmpty Function is an extension to the IEC 61131-3 standard.

Further Information

LinkedList Functions

For information about functions to manage LinkedList 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.