Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EightData Functions (continued)

DataSheetGetCellName Function

Overview

The DataSheetGetCellName function returns the name of a specified cell.

Syntax/Parameters

Syntax

string = DataSheetGetCellName ( handle hSheet, int row, int column );

string = DataSheetGetCellName ( handle hSheet, string row, string column );

string = DataSheetGetCellName ( handle hSheet, string address );

Parameters

hSheet

A handle to a Data Sheet object.

row

An int or string specifying a zero-based row or Y position for the cell.

column

An int or string specifying a zero-based column or X position for the cell.

address

A string specifying the cell position by cell address such as “A1”.

Return Value

Returns a string containing a copy of the cell’s name or an empty string if the cell does not have a name or on failure. Use the GetLastError function to retrieve error information.

Remarks

An empty string does not necessarily indicate an error since the cell may not have a name. Use the GetLastError function to determine if an error occurred. The name of a cell can be as large as 1024 characters.

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-12-13