Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter ThreeData Types and Operators (continued)

ClusterToArray Function

Overview

The ClusterToArray function imports a cluster into a dimensional variable.

Syntax/Parameters

Syntax

var [] = ArrayToCluster ( string data );

Parameters

data

A string specifying either cluster data or a source URL pointing to a file containing cluster data. If the string does not contain any line endings, it is assumed to be an URL.

Return Value

Returns data for a dimensional variable. The receiving variable will have zero elements on failure. Use the IsError and IsNotError to check for an error and/or GetLastError to retrieve a formatted error code. A zero-element variable can also be returned if the cluster is empty but contains a properly formatted header.

Remarks

A cluster is a structured string containing dimensional data. Cluster data does not carry a data type.

Improper dimensional matching can result in a runtime error.

Related Functions

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic