GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

TableToParameters Function

Overview

The TableToParameters function combines the rows of a table into a string of parameter pairs.

Syntax/Parameters

Syntax

string = TableToParameters ( 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 TableToParameters function is useful for transporting arrays of information as a string. Parameters are created as:

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

Each row becomes a property-value pair. Columns must have the key name “property” and “value” 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. Any additional columns are ignored.

Related Functions

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

ArrayToParameters — Converts an array with key names into a parameter list with optional delimiter.

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 — Converts a parameter list into a table with optional delimiter string.

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 12/16/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.