  |
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 ArrayToCluster function exports a dimensional variable to a cluster which can be later used to load to another variable.
Syntax/Parameters
Syntax
string = ArrayToCluster ( variable name, [string filename], [boolean decimal] );
Parameters
name
A name of a variable, which must be an array.
filename
An optional string specifying the destination for the data to be written. If the string is empty or not supplied, the cluster data is the return string.
decimal
An optional boolean, when set to TRUE (non-zero), causes decimal values to be used when expressing data where possible.
Return Value
Returns a string as empty or as cluster data. If the filename parameter is not supplied, an empty string indicates an error. Use the IsError and IsNotError to check for an error and/or GetLastError to retrieve a formatted error code.
Remarks
A cluster is a structured string containing dimensional data. Cluster data does not carry a data type.
When the decimal option is used, floating-point and integer based values are written in human readable format. Note that since floating-point is converted out (and presumably back in), precision issues must be considered. In native mode, the values are written as hexadecimal with the prefix ‘Fx’.
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.