Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EightData Functions (continued)

ArrayToParameters Function

Overview

The ArrayToParameters function combines the string array components of a key and data list into a string of parameter pairs.

Syntax/Parameters

Syntax

string = ArrayToParameters ( string data[], [string delimiter] );

Parameters

data

A string array containing parameter data to implode into a parameter string.

delimiter

An optional string that defines the delimiter that will be used to separate the parameter pairs. If omitted, the default is a line ending.

Return Value

Returns a string containing each parameter pair or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

The ArrayToParameters function is useful for transporting arrays of information as a string. Parameters are created as:

property-name-1: value; property-name-2: value;

The key name is used as the property name. Key names must be present in the array and cannot contain control characters or ‘:’ or ‘;’. If an array is in error, the GetLastError function will return ERROR_SYNTAX and the index will be placed in the low word of the error code.

Related Functions

Platform Support

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

Legato IDE, Legato Basic