GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Three — Data Types and Operators (continued)

ArrayAddKeyName Function

Overview

The ArrayAddKeyName function adds or supplements a single key name to an array on a specified axis.

Syntax/Parameters

Syntax

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

Parameters

name

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

key

A string containing the key name to add. Must be less than 64 characters. Exceeding 64 characters will result in a runtime error.

axis

An optional int specifying the axis to which the keys will be added. 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 int containing the index of the newly added key or existing index or ERROR_SOFT on failure. The lower part of the error code will contain specific information pertaining to the error.

Remarks

If a key name already exists, it is ignored. Key names cannot be larger than 64 characters. Common sources of errors include specifying an improper array, specifying an invalid dimension, or using a key name that is too large.

[need example of adding key]

Related Functions

ArrayAddKeyNames — Adds one or more key names to a specified axis.

[ArrayClearKeyNames]

[ArrayDeleteKeyName]

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 12/16/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.