zip

zip

zip

A collections of functions that supports the Zip and GZip functionality by using the Java Zip file API.

Metadata

Instantiating

AddFiles()

Add files to a new or an existing Zip file archive.

Arguments

Name Type Required Default Options Description
zipFilePath string Yes Pathname of the Zip file to add files.
files string No | (Chr(124)) delimited list of files to add to the Zip file. Required if argument 'directory' is not set.
directory string No Absolute pathname of directory to add to the Zip file. Required if argument 'files' is not set.
filter string No File extension filter. One filter can be applied. Only if argument 'directory' is set.
recurse boolean No no Get recursive files of subdirectories. Only if argument 'directory' is set.
compression numeric No 9 Compression level (0 through 9, 0=minimum, 9=maximum).
savePaths boolean No no Save full path info.

DeleteFiles()

Delete files from an existing Zip file archive.

Arguments

Name Type Required Default Options Description
zipFilePath string Yes Pathname of the Zip file to delete files from.
files string Yes | (Chr(124)) delimited list of files to delete from Zip file.

Extract()

Extracts a specified Zip file into a specified directory.

Arguments

Name Type Required Default Options Description
zipFilePath string Yes Pathname of the Zip file to extract.
extractPath string No [runtime expression] Pathname to extract the Zip file to.
extractFiles string No | (Chr(124)) delimited list of files to extract.
useFolderNames boolean No yes Create folders using the pathinfo stored in the Zip file.
overwriteFiles boolean No no Overwrite existing files.

FilesList()

Create an array with the file names of specified directory.

Arguments

Name Type Required Default Options Description
directory string Yes Absolute pathname of directory to get files list.
filter string No File extension filter. One filter can be applied.
recurse boolean No no Get recursive files of subdirectories.

gzipAddFile()

Create a new GZip file archive.

Arguments

Name Type Required Default Options Description
gzipFilePath string Yes Pathname of the GZip file to create.
filePath string Yes Pathname of a file to add to the GZip file archive.

gzipExtract()

Extracts a specified GZip file into a specified directory.

Arguments

Name Type Required Default Options Description
gzipFilePath string Yes Pathname of the GZip file to extract.
extractPath string No [runtime expression] Pathname to extract the GZip file to.

List()

List the content of a specified Zip file.

Arguments

Name Type Required Default Options Description
zipFilePath string Yes Pathname of the Zip file to list the content.

PathFormat()

Convert path into Windows or Unix format.

Arguments

Name Type Required Default Options Description
path string Yes The path to convert.