Zip:extract()

Zip:extract(path, [use_entrypath])method

Extract on the disk an entry with the given path/name in the Zip archive. The Zip archive should have been previously opened in "read" mode.

Parameters

path

A string representing the path and/or the name of the entry in the Zip archive to be extracted.

[use_entrypath]

An optional boolean value that indicates to extract the entry conserving its path or not.

Return value

Returns a File or a Directory representing the extracted entry on the disk.
Returns false if any error occured. You can check the Zip.error property to get the error message.

Example


-- extract an entry from a zip archive
import compression

-- check parameters : the archive and entry specified as argument
local archive = arg[1] or error("no archive specified")
local entry = arg[2] or error("no entry specified")

-- open the archive
local z = compression.Zip(archive)

-- extract the entry on the disk in the current directory or throws an error if false
local extracted = z:extract(entry) or error(z.error)

print(extracted.name.." has been successfully extracted to "..extracted.path)