  |
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 ArrayIsValidKeyName function tests a provided string as having valid syntax as an array key name.
Syntax/Parameters
Syntax
boolean = ArrayIsValidKeyName ( string key );
Parameters
key
A string specifying the key name to test.
Return Value
Returns an boolean as TRUE if the name is valid or FALSE if it is invalid.
Remarks
Array key names have few syntax limitations:
– No Leading or Trailing Space
– No Control Characters (must not be less than 0x20, or space character)
– Call be larger that ARRAY_MAX_KEY_NAME_SIZE - 1, or 79 characters.
This function can be used to control accessing array data when a string variable is used as a key. Since a bad key name will resulting in a Run Time Error (RTE), checking the syntax of the value is advisable if the source value is not within the programmer’s control.
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.