Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EightData Functions (continued)

ParametersToTable Function

Overview

The ParametersToTable function separates string components of a parameter list into a table of strings based on a delimiter string.

Syntax/Parameters

Syntax

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

Parameters

data

A string containing parameter data to explode.

delimiter

An optional string that defines the delimiter that will be used to separate the parameter pairs. If omitted, the default is either a line ending and/or ‘;’. See Remarks below.

Return Value

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

Remarks

The ParametersToTable function is useful for transporting arrays of information as string. Two columns are creates, column zero as key name “property” and column one as “value”. The parameters must be in the form of:

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

Note that if the delimiter parameter is omitted and left to default, there is a possibility of an ambiguous condition. For example, if it is assumed that the incoming data is line delimited and a parameter’s data contains a ‘;’ character, the data will be split. In such a case, specify “\r” for lines for “;” for single line lists.

The names can be up to 1024 characters and the values up to 1mb.

Related Functions

Platform Support

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

Legato IDE, Legato Basic