GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Eight — Data Functions (continued)

WorkbookOpen Function

Overview

The WorkbookOpen function opens an XDS file, loads the information table and mapped the data sheets. Sheet data is not loaded, only mapped.

Syntax/Parameters

Syntax

handle = WorkbookOpen ( handle hSheet, string filename );

Parameters

hSheet

A handle to a Data Sheet Object.

filename

A string specifying qualified filename to write the XDS data to.

Return Value

Returns a handle to a Workbook Object or NULL_HANDLE on failure. Use the GetLastError and GetLastErrorMessage to retrieve additional information.

Remarks

The incoming file must be in XDS format as specified in Appendix B — XML Data Sheet Format Specification of the SDK. Also note that for third party generators, each sheet must start on a fresh line within the file.

The open function will return error detail in the lower 16 bits of the formatted error code. These are as follows:

0x1001 — Syntax error in heading. Missing <xds> or XML header.

0x1003 — Incorrect namespace.

0x1010 — Premature end of file or error reading data.

0x1012 — Missing or inappropriate information table entry name.

0x1014 — Error reading sheet data.

0x1020 — Too many sheets in workbook.

Related Functions

WorkbookAddSheet — Adds a data sheet to a workbook.

WorkbookCreate — Creates a Workbook Object for XDS export.

WorkbookExport — Exports a workbook as an XDS file.

WorkbookGetSheet — Returns a data sheet object handle for a workbook sheet.

WorkbookGetInfoTable — Returns any globally named data (info table) from workbook.

WorkbookGetSheetCount — Returns the number of sheets within the workbook.

Platform Support

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

Legato IDE, Legato Basic

Page revised 2024-12-13

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.