Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6k

Application v 6.6a

  

 

Chapter ThreeData Types and Operators (continued)

ArrayHasKeyName Function

Overview

The ArrayHasKeyName function tests to see if a specified position along an array axis has a key name associated with it.

Syntax/Parameters

Syntax

boolean = ArrayHasKeyName ( variable name, int index, [int axis] );

Parameters

name

A name of a variable, which must be an array.

index

An int specifying the index to test.

axis

An optional int specifying the axis on which the index exists. The following are possible values:

Define Value Description
AXIS_A/AXIS_ROW (AXIS_X) 0 A dimension (rows)
AXIS_B/AXIS_COL (AXIS_Y) 1 B dimension (columns)
AXIS_C (AXIS_Z) 2 C dimension

 

The default value is AXIS_A. Note that X, Y and Z are maintained for backward compatibility.

Return Value

Returns a boolean value as TRUE if the position contains a key name or FALSE if it does not.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

Page revised 2026-09-14