UA_NamespaceGetIndexList

Overview

Type:

Function block

Available as of:

V1.0.0.0

Functional Description

The function block UA_NamespaceGetIndexList is used to get the namespace indexes of several namespace URIs.

NOTE: The function block reads the server object NamespaceArray and returns the indexes of the requested elements. The namespace index is an element within the structure UANodeID, which is required for subsequently used function blocks.
NOTE: To help avoid an inconsistent response, do not modify parameters while the function block is executing (Busy = TRUE).
 WARNING
UNINTENDED EQUIPMENT OPERATION
Do not modify input parameters while the Busy output is equal to TRUE.
Failure to follow these instructions can result in death, serious injury, or equipment damage.

Interface

Input

Data type

Description

Execute

BOOL

Upon a rising edge, the function block is being executed.

Also refer to Behavior of Function Blocks with the Input Execute.

Timeout

TIME

Maximum time to respond.

Value range: 2 s...60 s

If the value is out of range the upper or lower limit is applied.

Default value: GPL.Timeout

ConnectionHdl

DWORD

Connection handle.

NamespaceUrisCount

UINT

Number of namespace URIs in NamespaceUris array.

Value range: 1.. GPL.MAX_ELEMENTS_NAMESPACES

NamespaceUris

ARRAY [1..GPL.MAX_ELEMENTS_NAMESPACES] OF STRING [255]

Array containing namespace URIs.

Output

Data type

Description

Done

BOOL

Indicates that the execution of the function block was completed successfully.

Busy

BOOL

Indicates that the execution of the function block is in progress.

Error

BOOL

Indicates that an error was detected during execution.

NOTE: Even if Error indicates FALSE, verify the corresponding ErrorIDs before processing the namespace indexes.

ErrorIDs

ARRAY [1..GPL.MAX_ELEMENTS_NAMESPACES] OF ET_Result

Provides additional diagnostic information as a numeric value.

For each specified namespace URI, a separate result is provided.

NamespaceIndexes

ARRAY [1..GPL.MAX_ELEMENTS_NAMESPACES] OF UINT

Provides retrieved namespace indexes.