  |
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 ArrayGetKeys function returns an array of all key names within an array in the order of the key name position.
Syntax/Parameters
Syntax
string[] = ArrayGetKeys ( variable name, [int axis] );
Parameters
name
An optional int specifying the axis from which the key names will be returned. 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 |
Specifying -1 will direct the function to return key names from all the dimensions available. The default value is AXIS_X.
Return Value
Returns a string array containing the key names corresponding to each index position that has been used or an empty array on error. Use the GetLastError function to retrieve error information.
Remarks
The key names are returned sequentially in the order they appear in the array. If a key has not been specified for a specified index, that array position will be empty.
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.