  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Six — File Functions (continued)
Overview
The ZipEnumerateEntries function returns a string array of entry names, which can be files and/or path names, from within a Zip Object.
Syntax/Parameters
Syntax
string[] = ZipEnumerateEntries ( handle hZip );
Parameters
hZip
A handle for a Zip Object created with the ZipOpen function.
Return Value
Returns a string array containing a name for each entry within the Zip Object or an empty array on failure. Use the GetLastError function to retrieve error information.
Remarks
The list will be a one-for-one match with the entry positions within the Zip Object. The index positions in the array will match the positions within the Zip Object. The names may or may not contain partial or full path names or just file names. Because both an empty zip file and an error will cause an empty array to be returned, the GetLastError function should be used. If the Zip Object is empty, the GetLastError function will return ERROR_EOD.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.