Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SixFile Functions (continued)

ZipEnumerateFiles Function

Overview

The ZipEnumerateFiles function returns a string array containing the filenames within a Zip Object with paths as appropriate.

Syntax/Parameters

Syntax

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

Folder only entries within the zip file list are not returned. Path delimiters are always converted to MS style backslashes.

Note that the index positions of the array will not necessarily match the index positions of the 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