  |
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 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_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 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
| 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.