Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6j

Application v 6.5c

  

 

Chapter ElevenSGML Functions (continued)

xBRL-CSV

XBRLGetTableRow Function

Overview

The XBRLGetTableRow function returns the content of the associated CSV table as a row.

Syntax/Parameters

Syntax

string[] = XBRLGetTableRow ( handle hXM, string id | int index, int row);

Parameters

hXM

A handle to an XBRL Object containing taxonomy data.

id

A string containing a table identifier. The value is case-sensitive. Or,

index

A zero-based int value specifying the table.

row

A zero-based int value specifying the row table to retrieve.

Return Value

Returns a string list containing a row of information from the CSV of the specified table an empty array on failure. Use the GetLastError function to retrieve a formatted error code and the GetLastErrorMessage function to retrieve additional error information.

Remarks

The returned data is “as is” from the imported CSV companion file. Information is extracted from the associated Data Sheet Object. The handle to the Data Sheet Object can be retrieved using the XBRLGetTableDataSheet function.

Note that the first row contains the Column Identifiers. The returned string table contains the column identifier as the array key name. It is possible for the function to encounter key name syntax errors with respect to the restrictions of Legato’s key names. In the case of an error, the first error is logged in the last error message. For example:

Key name error index 12

or

Key name errors starting at index 12

The message will contain a reference to the first column error while the formatting error code will be ERROR_SYNTAX ORed with the number of syntax errors. The column identifier will be replaced with:

[Key error index 12]

Key name errors will not prevent retrieving the row’s data. To resolve the key name restrictions, an index of column identifiers can be created by getting row 0.

[should the key names column identifier be abandoned? the main issue is the 80 character limit]

Related Functions

Platform Support

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

Page revised 2026-07-20