[Overview][Constants][Types][Classes][Index] Reference for unit 'Zipper' (#fcl)

TUnZipper

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Extracts and decompresses files and directories in a .ZIP archive file

Declaration

Source position: zipper.pp line 525

type TUnZipper = class(TObject)

public

  constructor Create;

  

Constructor for the class instance

  destructor Destroy; override;

  

Destructor for the class instance

  procedure UnZipAllFiles();

  

Unzips all files in a zip file, writing them to disk

  procedure UnZipFile();

  

Unzips a single file found in the specified .ZIP archive

  procedure UnZipFiles();

  

Unzips the specified files in a .ZIP archive file

  class procedure Unzip();

  

Unzips the specified .ZIP archive file

  procedure Clear;

  

Removes all entries and files from object

  procedure Examine;

  

Opens zip file and reads the directory entries (list of zipped files)

  procedure Terminate;

  

Sets the value in Terminated to True

  property BufferSize: LongWord; [rw]

  

Size of the buffer used to read and decompress entries in the .ZIP file

  property OnOpenInputStream: TCustomInputStreamEvent; [rw]

  

Event handler signalled when the input stream for the .ZIP file is opened

  property OnCloseInputStream: TCustomInputStreamEvent; [rw]

  

Event handler signalled when the input stream for the .ZIP file is closed

  property OnCreateStream: TOnCustomStreamEvent; [rw]

  

Event handler signalled when an output stream is created

  property OnDoneStream: TOnCustomStreamEvent; [rw]

  

Event handler signalled when an output stream is closed

  property OnPercent: Integer; [rw]

  

Threshold percentage which triggers a progress notification

  property OnProgress: TProgressEvent; [rw]

  

Progress event handler used when decompressing files

  property OnProgressEx: TProgressEventEx; [rw]

  

Extended progress event handler used when decompressing files

  property OnStartFile: TOnStartFileEvent; [rw]

  

Callback procedure that will be called before unzipping a file

  property OnEndFile: TOnEndOfFileEvent; [rw]

  

Callback procedure that will be called after unzipping a file

  property FileName: RawByteString; [rw]

  

Path and file name for the .zip file to be unzipped / processed

  property OutputPath: RawByteString; [rw]

  

Path where archive files will be unzipped

  property FileComment: string; [r]

  

Comment stored in the .ZIP archive file

  property Files: TStrings; [r]

  

Files in the zip file (deprecated)

  property Entries: TFullZipFileEntries; [r]

  

Collection with TFullZipFileEntry instances for files and directories stored in the .ZIP archive

  property UseUTF8: Boolean; [rw]

  

Indicates that the UTF-8-encoded names are used when locating and unzipping entries in the archive

  property Flat: Boolean; [rw]

  

Extracts files to a single directory

  property Terminated: Boolean; [r]

  

True if the Terminate method has been called

end;

Inheritance

TUnZipper

  

Extracts and decompresses files and directories in a .ZIP archive file

|

TObject


Documentation generated on: May 14 2021