GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data 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

ArrayGetKeyName — Gets the name of a key at a specified index.

GetParameterName — Gets the name from a property/parameter value pair.

GetParameterValue — Gets the value from a property/parameter value pair.

ParametersToArray — Converts a parameter list into a string array with key names for the property names with optional delimiter string.

ParametersToTable

TableToParamters

Platform Support

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

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 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.