Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter EightData Functions (continued)

CSVGetStringField Function

Overview

The CSVGetStringField function retrieves the next CSV field for the current record and returns it as a string.

Syntax/Parameters

Syntax

string = CSVGetStringField ( handle hCSV );

Parameters

hCSV

A handle to a valid CSV Object.

Return Value

Returns a string representing the next field in a CSV record or an empty string on failure. Use the GetLastError function to differentiate between errors, empty fields, and the end of the record. The resulting string cannot be larger than 1,048,575 characters.

Remarks

The CSVGetStringField function can be used to serially enumerate data from a CSV record, presumably in an unstructured manner. The record can be set by the CSVSetRecord function or during initialization using the CSVCreate function.

If the hCSV parameter is invalid, the GetLastError function will return ERROR_INVALID_HANDLE.

Related Functions

Platform Support

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

Legato IDE, Legato Basic