Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.6d

Application v 6.1b

  

 

Chapter EightData Functions (continued)

WorkbookDeleteSheet Function

Overview

The WorkbookDeleteSheet function deletes a data sheet from a workbook at a specified location.

Syntax/Parameters

Syntax

int = WorkbookDeleteSheet ( handle hWorkbook, int index );

Parameters

hWorkbook

A handle to a Workbook Object.

index

An int specifying the zero-based position to insert the sheet. If the value is -1 the sheet is appended to the workbook list of sheets.

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

If the data sheet was supplied via an add or insert, the associated handle will automatically be closed and the handle will become invalid.

This function does not update the internal information table. It is updated when the workbook is exported.

Related Functions

Platform Support

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

Page revised 2025-08-15