Sign in Join
FPDoc Onlineexperiment

TUnZipper.Unzip procedure

Member of TUnZipperpublicIn unit Zipper

Unzips the specified .ZIP archive file.

Declaration

pascal
class procedure Unzip(const AZipFileName: RawByteString)
class procedure Unzip(const AZipFileName: RawByteString; 
 aExtractFileName: RawByteString)
class procedure UnZip(const AZipFileName: RawByteString; 
 const aExtractFileName: RawByteString; 
 aOutputFileName: AnsiString)
class procedure Unzip(const AZipFileName: RawByteString; 
 aFileList: Array of RawByteString)
class procedure Unzip(const AZipFileName: RawByteString; 
 aFileList: TStrings)
class procedure Unzip(const AZipFileName: RawByteString; 
 aFileList: Array of RawByteString; 
 aOutputDir: RawByteString; aFlat: Boolean=False)
class procedure Unzip(const AZipFileName: RawByteString; 
 aFileList: TStrings; aOutputDir: RawByteString; 
 aFlat: Boolean=False)

Arguments

AZipFileName

Name of the .ZIP archive file.

aExtractFileName

Name of a file or directory entry to extract in the method.

aOutputFileName
aFileList

List of file names to unzip in the method.

aOutputDir
aFlat

Description

UnZip is an overloaded class method used to unzip one or more files in the specified .ZIP archive file. Overloaded variants are provided which allow the file or files to be specified using RawByteString, Array, or TStrings data types.

UnZip is a convenience method, and does not require an instance of the class. It uses the default options to perform the unzip operation.

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.