  |
GoFiler Legato Script Reference
Legato v 1.5d Application v 5.25a
|
| Table of Contents | < < Previous | Next >> |
Chapter Eight — Data Functions (continued)
Overview
The WorkbookGetSheet function retrieves sheet of an open workbook.
Syntax/Parameters
Syntax
handle = WorkbookGetSheet ( handle hWorkbook, string name | int index );
Parameters
hWorkbook
A handle to a Workbook Object.
name
A string specifying the name of the sheet to reference. Or,
index
A zero-base int specifying the sheet position.
Return Value
Returns a handle to a Data Sheet Object or NULL_HANDLE on failure. Use the GetLastError and GetLastErrorMessage to retrieve additional information.
Remarks
When a workbook is opened, the sheet positions are mapped but the data is not loaded. Getting a sheet from, the workbook creates a Data Sheet Object and then loads the sheet’s data into the object. A handle to the newly create object is then returned.
The handle should be closed when actions have been completed using the CloseHandle function.
The state of the Workbook Object is not altered and it does not store the Data Sheet handle on completion.
Related Functions
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 >> |
© 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.