Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.4j

Application v 5.22b

  

 

Chapter SixFile Functions (continued)

ZipEnumerateFolders Function

Overview

The ZipEnumerateFolders function returns a string array of folder names within a Zip Object.

Syntax/Parameters

Syntax

string[] = ZipEnumerateFolders ( 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

Some zip files contain separate folder names as entries while other do not. This function looks for discrete names without regard to the zip file having separate entries. A Zip Object need not contain any folder designations.

Note that the index positions of the array will not match the index positions of entries within the Zip Object. See the ZipEnumerateEntries function for a one-to-one list of folders and files. 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