Sign in Join
FPDoc Onlineexperiment

TUnZipper class

In unit Zipper

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

Declaration

pascal
TUnZipper = class(TObject)

Inheritance

  1. TUnZipper
  2. TObject

Description

Nothing more than the line above yet.

Properties

BufferSizepublicSize of the buffer used to read and decompress entries in the .ZIP file.
FileNamepublicPath and file name for the .zip file to be unzipped / processed.
OutputPathpublicPath where archive files will be unzipped.
FileCommentpublicComment stored in the .ZIP archive file.
FilespublicFiles in the zip file (deprecated).
EntriespublicCollection with TFullZipFileEntry instances for files and directories stored in the .ZIP archive.
UseUTF8publicIndicates that the UTF-8-encoded names are used when locating and unzipping entries in the archive.
FlatpublicExtracts files to a single directory.
TerminatedpublicTrue if the Terminate method has been called.

Methods

OpenInputprotected
CloseOutputprotected
CloseInputprotected
FindEndHeadersprotected
ReadZipDirectoryprotected
ReadZipHeaderprotected
DoEndOfFileprotected
OpenOutputprotected
SetBufSizeprotected
SetFileNameprotected
SetOutputPathprotected
CreateDeCompressorprotected
CreatepublicConstructor for the class instance.
DestroypublicDestructor for the class instance.
UnZipOneFilepublic
UnZipAllFilespublicUnzips all files in a zip file, writing them to disk.
UnZipFilepublicUnzips a single file found in the specified .ZIP archive.
UnZipFilespublicUnzips the specified files in a .ZIP archive file.
UnzippublicUnzips the specified .ZIP archive file.
ClearpublicRemoves all entries and files from object.
ExaminepublicOpens zip file and reads the directory entries (list of zipped files).
TerminatepublicSets the value in Terminated to True.

Events

OnOpenInputStreampublicEvent handler signalled when the input stream for the .ZIP file is opened.
OnCloseInputStreampublicEvent handler signalled when the input stream for the .ZIP file is closed.
OnCreateStreampublicEvent handler signalled when an output stream is created.
OnDoneStreampublicEvent handler signalled when an output stream is closed.
OnPercentpublicThreshold percentage which triggers a progress notification.
OnProgresspublicProgress event handler used when decompressing files.
OnProgressExpublicExtended progress event handler used when decompressing files.
OnStartFilepublicCallback procedure that will be called before unzipping a file.
OnEndFilepublicCallback procedure that will be called after unzipping a file.

Inherited

From TObject (40)

AfterConstruction BeforeDestruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName SafeCallException StringMessageTable SystemHasExtendedRTTI ToString UnitName

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