Top Method Summary
Options Name Purpose
ExtractAll (character) Extracts all entries of the archive into a folder Notes : Missing folders are created, existing files are overwritten. Raises an InvalidZipEntryNameException when an entry name is absolute or refers to a parent folder, before anything is extracted. @param pcFolderName The name of the target folder */
LONGCHAR ExtractText (character) Extracts an entry as text Notes : The content of the entry is expected to be UTF-8 encoded @param pcEntryName The name of the entry @return The text */
ExtractToFile (character, character) Extracts an entry into a file Notes : Missing folders are created, an existing file is overwritten. For a folder entry the folder is created. @param pcEntryName The name of the entry @param pcFileName The name of the target file */
ExtractToMemptr (character, memptr) Extracts an entry into a MEMPTR Notes : The caller is responsible for freeing the MEMPTR. An empty entry returns a MEMPTR with a size of 0. @param pcEntryName The name of the entry @param pmData OUTPUT The content of the entry */
FindEntry (character) Positions the ttEntry buffer on an entry Notes : Raises a ZipEntryNotFoundException when the archive does not contain the entry @param pcEntryName The name of the entry */
INT64 GetDataPosition () Returns the 1-based position of the data of the entry in the ttEntry buffer Notes : Validates the local file header @return The position of the data */
Consultingwerk.Framework.Compression.ZipEntry GetEntries () Returns the entries of the archive Notes : In the order of the central directory. Returns an indeterminate array for an archive without entries. @return The entries */
Consultingwerk.Framework.Compression.ZipEntry GetEntry (character) Returns an entry of the archive Notes : Raises a ZipEntryNotFoundException when the archive does not contain the entry @param pcEntryName The name of the entry @return The entry */
LOGICAL HasEntry (character) Returns if the archive contains an entry Notes : @param pcEntryName The name of the entry @return Logical value indicating if the archive contains the entry */
Consultingwerk.Framework.Compression.ZipEntry NewZipEntry () Returns a new ZipEntry instance for the entry in the ttEntry buffer Notes : @return The ZipEntry instance */
ReadCentralDirectory () Reads the central directory of the archive into the ttEntry temp-table Notes : */

Top Constructor Summary
Options Name Purpose
ZipArchiveReader (character) Constructor for the ZipArchiveReader class Notes : Reads the ZIP archive from a file @param pcFileName The name of the ZIP archive file */
ZipArchiveReader (memptr) Constructor for the ZipArchiveReader class Notes : Reads the ZIP archive from a MEMPTR. The reader works on a copy, so the caller may free the MEMPTR afterwards. @param pmArchive The ZIP archive */

Top Property Summary
Options Name Purpose
INTEGER EntryCount


Method Detail
Top

ExtractAll (character)

Purpose: Extracts all entries of the archive into a folder
Notes : Missing folders are created, existing files are overwritten.
Raises an InvalidZipEntryNameException when an entry name is
absolute or refers to a parent folder, before anything is
extracted.

Parameters:
pcFolderName CHARACTER
The name of the target folder
Top

LONGCHAR ExtractText (character)

Purpose: Extracts an entry as text
Notes : The content of the entry is expected to be UTF-8 encoded

Parameters:
pcEntryName CHARACTER
The name of the entry
Returns LONGCHAR
The text
Top

ExtractToFile (character, character)

Purpose: Extracts an entry into a file
Notes : Missing folders are created, an existing file is overwritten.
For a folder entry the folder is created.

Parameters:
pcEntryName CHARACTER
The name of the entry
pcFileName CHARACTER
The name of the target file
Top

ExtractToMemptr (character, memptr)

Purpose: Extracts an entry into a MEMPTR
Notes : The caller is responsible for freeing the MEMPTR. An empty
entry returns a MEMPTR with a size of 0.

Parameters:
pcEntryName CHARACTER
The name of the entry
pmData MEMPTR
OUTPUT The content of the entry
Top

FindEntry (character)

Purpose: Positions the ttEntry buffer on an entry
Notes : Raises a ZipEntryNotFoundException when the archive does not
contain the entry

Parameters:
pcEntryName CHARACTER
The name of the entry
Top

INT64 GetDataPosition ()

Purpose: Returns the 1-based position of the data of the entry in the
ttEntry buffer
Notes : Validates the local file header

Returns INT64
The position of the data
Top

Consultingwerk.Framework.Compression.ZipEntry GetEntries ()

Purpose: Returns the entries of the archive
Notes : In the order of the central directory. Returns an
indeterminate array for an archive without entries.

Returns Consultingwerk.Framework.Compression.ZipEntry
The entries
Top

Consultingwerk.Framework.Compression.ZipEntry GetEntry (character)

Purpose: Returns an entry of the archive
Notes : Raises a ZipEntryNotFoundException when the archive does not
contain the entry

Parameters:
pcEntryName CHARACTER
The name of the entry
Returns Consultingwerk.Framework.Compression.ZipEntry
The entry
Top

LOGICAL HasEntry (character)

Purpose: Returns if the archive contains an entry
Notes :

Parameters:
pcEntryName CHARACTER
The name of the entry
Returns LOGICAL
Logical value indicating if the archive contains the entry
Top

Consultingwerk.Framework.Compression.ZipEntry NewZipEntry ()

Purpose: Returns a new ZipEntry instance for the entry in the ttEntry
buffer
Notes :

Returns Consultingwerk.Framework.Compression.ZipEntry
The ZipEntry instance
Top

ReadCentralDirectory ()

Purpose: Reads the central directory of the archive into the ttEntry
temp-table
Notes :



Constructor Detail
Top

ZipArchiveReader (character)

Purpose: Constructor for the ZipArchiveReader class
Notes : Reads the ZIP archive from a file

Parameters:
pcFileName CHARACTER
The name of the ZIP archive file
Top

ZipArchiveReader (memptr)

Purpose: Constructor for the ZipArchiveReader class
Notes : Reads the ZIP archive from a MEMPTR. The reader works on a copy,
so the caller may free the MEMPTR afterwards.

Parameters:
pmArchive MEMPTR
The ZIP archive


Property Detail
Top

INTEGER EntryCount


Returns INTEGER


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:04:38