Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter EightData Functions (continued)

DataSheetEnumerateNamedCells Function

Overview

The DataSheetEnumerateNamedCells function scans the object and returns a table of cell names and locations.

Syntax/Parameters

Syntax

string[][] = DataSheetEnumerateNamedCells ( handle hSheet );

Parameters

hSheet

A handle to a Data Sheet Object.

Return Value

Returns a string table with a row for each named position or an empty array on failure. Use the GetLastError and GetLastErrorMessage to retrieve further information on error. Enumerating a sheet with no named cells will return an error.

Remarks

The return data is a two-dimensional array with a row entry for each cell and three columns containing the keyed names “Name”, “Row”, “Column” and “Cell”. The row and column values are zero-based string representation of the position. The cell value is a cell address such as “B17”.

If the sheet does not contain a named cells, an empty array will be returned with that last error being set as ERROR_EOD.

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-10-21