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

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

CSVCreate Function

Overview

The CSVCreate function creates a CSV Object for loading, reading and writing comma-separated values.

Syntax/Parameters

Syntax

handle = CSVCreate ( [string data] );

Parameters

data

An optional string representing the line of data to be read as CSV. The record cannot be larger than 1,048,575 characters. The string can be delimited by returns in such case each line is treated as a record or row during read.

Return Value

Returns a handle for the CSV Object or NULL_HANDLE on failure. Use the GetLastError function to retrieve error information.

Remarks

The CSVCreate function creates and, depending on whether the data parameter is empty, initializes a CSV Object for later use by related functions. CSV Objects are useful for parsing comma-delimited information, which is commonly produced by spreadsheet and other text applications. The CloseHandle function should be used to release the resources of a CSV Object. Use the get field functions to retrieve data.

Related Functions

CSVAppendField — Appends a value to a CSV Object write buffer.

CSVGetFieldCount — Returns a count of CSV fields within a record either as part of a CSV Object or independent string.

CSVGetFields — Returns all the CSV fields from a CSV Object for a simple CSV string.

CSVGetNumericField — Gets and translates a field from a CSV Object into a numeric value.

CSVGetStringField — Gets and translates a field from a CSV Object into a string value.

CSVReset — Resets the read and write buffers within a CSV Object.

CSVSetRecord — Sets a string (record) into the CSV Object’s parse buffer.

CSVWriteRecord — Writes the current CSV Object buffer to the specified Basic File Object handle.

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.