  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
Overview
The CSVGetFields function retrieves all fields from a CSV row or record and places the data into a string array.
Syntax/Parameters
Syntax
string[] = CSVGetFields ( handle hCSV, [string source] );
string[] = CSVGetFields ( string source );
Parameters
hCSV
A handle to a CSV Object. When provided, the object is used as a base to retrieving data.
source
A string that contains the source information to be parsed from CSV to separate string fields. If a handle to a CSV Object is not provided, then the source string is required. If the a handle to a CSV Object is provided, the source string parameter will replace the current content as if the CSVSetRecord function has been called.
Return Value
Returns an array of strings parsed from the source buffer or an empty array on failure. Use the GetLastError function to retrieve error information.
Remarks
The input data can be a CSV Object or a simple CSV string. When used with an object, the function can be used to load a series of records from a single multi-line string. If a CSV Object is not employed, the source is considered to be a single row and will be parsed until the end of the string is reached for a line break. When a string is set into a CSV Object, line breaks will result in multiple records with a specific code that returns TRUE when calling the GetLastError function.
Because an empty source string will return no error with an empty array, the GetLastError function should be used to determine if an error occurs.
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.