GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Three — Data Types and Operators (continued)

ArrayIsKeyName Function

Overview

The ArrayIsKeyName function tests a specified key name and returns true or false as to its existence.

Syntax/Parameters

Syntax

boolean = ArrayIsKeyName ( variable name, string key, [int axis] );

Parameters

name

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

key

A string specifying the key name to find.

axis

An optional int specifying the axis to search. The following are possible values:

Define	Value	Description
AXIS_X/AXIS_ROW	0	X dimension (rows)
AXIS_Y/AXIS_COL	1	Y dimension (columns)
AXIS_Z	2	Z dimension

 

The default value is AXIS_X.

Return Value

Returns an boolean specifying the existence of a key name or FALSE on failure. Use the IsError, IsNotError, or GetLastError functions to retrieve error information.

If the return value is TRUE, the last error will contain the key index value.

Specifying an invalid axis will result in an error.

Remarks

The search is case-sensitive. Note that a failure of the function is indicated by a FALSE condition and as such the IsError function should be used to determine if an error occurred. The only valid non-RTE error is a bad axis parameter.

Related Functions 

ArrayFindKeyName — Finds a key name for a specified array and a specific axis.

ArrayGetKeyName — Gets the name of a key at a specified index.

ArrayGetKeys — Gets an array of the key names for a specified axis.

ArrayHasKeyName — Checks an index position for the presence of a key name.

ArrayIsValidKeyName — Tests a string as a valid key name.

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.