Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter NineDialog Functions (continued)

DataControlLoadList Function

Overview

The DataControlLoadList function loads a data control with a compound string that can be in a number of formats.

Syntax/Parameters

Syntax

int = DataControlLoadList ( int id, string data, [boolean csv_mode] );

Parameters

id

An int containing the control ID of a data control.

data

A UTF encoded string formatted as either lines of data to add or a comma- or a space-delimited list.

csv_mode

An optional boolean value specifying whether to interpret line data as a CSV table. The default value is FALSE.

Return Value

An int containing the index of the last item added or a formatted error code on failure. Common error codes are as follows: ERROR_RANGE if id is an invalid control ID for the open dialog or ERROR_INVALID_HANDLE if no dialog is open. Use the GetLastError function to retrieve error information.

Remarks

For maximum flexibility, the source string can be formatted as text lines or a comma- or space-delimited list. For example:

Lines – “Apples\r\n\Oranges\r\nBananas”

Comma – “Apples,Oranges,Bananas”

Spaces – “Apples Oranges Bananas”

In line mode, the csv_mode becomes active. If not set to TRUE, tabs are interpreted as cell delimiters. when set to TRUE, the line is interpreted as CSV.

Row (or record) endings are interpreted as \r, \r\n or \n.

Related Functions

Platform Support

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

Legato IDE, Legato Basic