Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EightData Functions (continued)

DataSheetIsCellProtected Function

Overview

The DataSheetIsCellProtected function tests to see if a specified cell within a Data Sheet object is protected.

Syntax/Parameters

Syntax

boolean = DataSheetIsCellProtected ( handle hSheet, int row, int column );

boolean = DataSheetIsCellProtected ( handle hSheet, string row, string column );

boolean = DataSheetIsCellProtected ( 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 TRUE if the cell is protected or FALSE if it is not or if an error has occurred. Use the GetLastError function to retrieve error information.

Remarks

Null cells will be returned as valid and FALSE. Because FALSE can be both a valid return value and an indication of an error, the GetLastError function should be checked to determine if an error has occurred.

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-12-13