  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
Overview
The ParametersToArray function separates string components of a parameter list into an array of strings based on a delimiter string.
Syntax/Parameters
Syntax
string[] = ParametersToArray ( 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 array containing each parameter pair string as a key and data or an empty array on failure. Use the GetLastError function to retrieve error information.
Remarks
The ParametersToArray function is useful for transporting arrays of information as string. The property name is used as the array entry key name. The parameters must be in the form of:
property-name-1: value; property-name-2: value;
The property name must be less than the key size. If not, an error count will be set and the key name truncated. Duplicate property names will be removed with the last duplicate item used for the property value. Blank lines or lines with no property name are also ignored.
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.
If there are duplicate parameter/key names, the last value in the list is applied to the existing key.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| Table of Contents | < < Previous | Next >> |
© 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.