  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Three — Data Types and Operators (continued)
Overview
The ArrayAddKeyNames function adds or supplements key names to an array on a specified axis.
Syntax/Parameters
Syntax
int = ArrayAddKeyNames ( variable name, string keys, [int axis] );
Parameters
name
A name of a variable, which must be an array.
keys
A string formatted as lines of data to add, either comma delimited or space delimited. The keys are added in the order they occur in the keys string.
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 as ERROR_NONE with the low word containing the number of items added or an int containing a formatted error code. On error, the offending item number is located in the low word.
Remarks
If a key name already exists, it is ignored. More keys can be added than the array has members.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.