Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter EightData Functions (continued)

WorkbookAddSheet Function

Overview

The WorkbookAddSheet function adds a data sheet to a workbook.

Syntax/Parameters

Syntax

int = WorkbookAddSheet ( handle hWorkbook, handle hSheet, string name );

Parameters

hWorkbook

A handle to a Workbook Object.

hSheet

A handle to a Data Sheet Object.

name

An optional string specifying the name of the data sheet. If the data sheet does not have a name and one is not provided, a default name will be added to the Data Sheet Object based on the relative position in the workbook.

Return Value

Returns an int as ERROR_NONE or a formatted error code on failure. Use the GetLastError and GetLastErrorMessage to retrieve additional information.

Remarks

Each handle is added to an internal array for later use on export. The object handles added must remain intact until the workbook is written.

Up to 512 data sheets can be added.

Note that this function was referred to as DataSheetAddToWorkbook prior to version 1.5c. There is no legacy support.

Related Functions

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-12-13