TChilkatZipEntry

Gets or sets the comment stored in the ZIP archive for this entry.

The compressed size of this entry, in bytes.

For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.

For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:

• The current uncompressed data size for data entries.
• The cached filesystem file size for referenced file entries.

After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.

The compressed size of this entry as a decimal string.

For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.

For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:

• The current uncompressed data size for data entries.
• The cached filesystem file size for referenced file entries.

After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.

This property is useful when sizes may exceed the range of a 32-bit integer.

Gets or sets the compression level for this entry.

A value of 0 means no compression, and a value of 9 means maximum compression.

The default value is 6.

Gets or sets the compression method used for this entry.

• 0 means no compression.
• 8 means Deflate compression.

Deflate is the standard compression algorithm used by common ZIP utilities such as WinZip.

The CRC value for this ZIP entry.

For AES-encrypted entries, the CRC value is 0.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

The AES encryption key length for this entry.

If this entry is AES encrypted, the value is 128, 192, or 256.

If this entry is not AES encrypted, the value is 0.

A unique identifier assigned to this entry while the ZIP object is instantiated in memory.

This ID can be used to retrieve the same entry later with Zip.EntryById.

Indicates the origin and current state of this ZIP entry.

• 0 — Mapped Entry: an entry that already exists in an open ZIP file.
• 1 — File Entry: a file in the local filesystem that has been referenced, but not yet read or compressed.
• 2 — Data Entry: an entry containing uncompressed data already held in memory.
• 3 — Null Entry: an entry that no longer exists in the ZIP archive.
• 4 — New Directory Entry: a directory entry added to the ZIP object.

When the ZIP archive is written by calling WriteZip or WriteToMemory, entries are transformed into mapped entries. In other words, after writing, they point to compressed data contained in the newly created or rewritten ZIP archive.

Gets or sets the local last-modified date/time for this ZIP entry in RFC 822 string format.

Example RFC 822 date/time strings:

Tue, 15 Nov 1994 12:45:26 GMT
Fri, 05 Jan 2024 18:30:00 -0500

The timezone may be specified either as a named timezone such as GMT, or as a numeric UTC offset such as -0500.

Gets or sets the filename, including any relative path, stored for this entry inside the ZIP archive.

Changing this property changes the path/name that will appear in the ZIP archive. It does not rename a source file in the local filesystem.

Returns the raw filename bytes found in the ZIP entry, encoded as a hexadecimal string.

This can be useful for diagnosing filename encoding issues.

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.

Indicates whether this ZIP entry is AES encrypted.

This property can be 1 only for entries already contained in a ZIP archive, such as entries obtained after calling OpenZip, OpenBd, or OpenFromMemory.

If the entry is not AES encrypted, the property is 0.

Indicates whether this ZIP entry is a directory entry.

The value is 1 if the entry represents a directory, and 0 if it represents a file.

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

The length, in characters, of the string contained in the LastStringResult property.

Gets or sets the text flag in the internal file attributes for this ZIP entry.

This flag indicates whether the entry contents should be considered text rather than binary data.

The flag is informational and does not need to be accurate for normal ZIP processing. It is provided for compatibility with applications that may be sensitive to this attribute.

The uncompressed size of this entry, in bytes.

The uncompressed size of this ZIP entry as a decimal string.

This is useful when the uncompressed size may be larger than what can safely be represented by a 32-bit integer.

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version of the component/library, such as "10.1.0"

Appends binary data to this ZIP entry's file contents.

If this entry is already a Data Entry (EntryType = 2), then the bytes in inData are appended directly to the existing uncompressed in-memory data.

If this entry is not already a Data Entry, then the entry is first converted into a Data Entry before the new data is appended.

• If the entry is a mapped entry (EntryType = 0), the compressed ZIP entry data is first inflated into memory. The new data is then appended, and the entry becomes a Data Entry containing the combined uncompressed data.
• If the entry is a file entry (EntryType = 1), the referenced filesystem file is first loaded into memory. The new data is then appended, and the entry becomes a Data Entry containing the combined data.

After this method is called, the entry contents exist entirely as uncompressed in-memory data associated with the ZipEntry object.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AppendData method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Appends text data to this ZIP entry's file contents.

The text is converted to bytes using the character encoding specified by charset, such as utf-8, utf-16, or ansi.

If this entry is already a Data Entry (EntryType = 2), then the encoded bytes are appended directly to the existing uncompressed in-memory data.

If this entry is not already a Data Entry, then the entry is first converted into a Data Entry before the new text data is appended.

• If the entry is a mapped entry (EntryType = 0), the compressed ZIP entry data is first inflated into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined uncompressed data.
• If the entry is a file entry (EntryType = 1), the referenced filesystem file is first loaded into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined data.

After this method is called, the entry contents exist entirely as uncompressed in-memory data associated with the ZipEntry object.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AppendString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Returns the compressed data for this ZIP entry as a byte array.

This method can only be called when the entry already contains compressed data. In other words, the entry must be a mapped entry.

This is the case when an existing ZIP archive has been opened, or after a ZIP archive has been written using WriteZip or WriteToMemory.

If the entry was added using methods such as AppendData, AppendFiles, or AddFile, it does not yet contain compressed data. The entry becomes a mapped entry after the ZIP archive is written.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

Returns the compressed data for this ZIP entry as a Base64-encoded string.

This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.

This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.

Returns a zero-length WideString on failure

Returns the compressed data for this ZIP entry as a hexadecimal encoded string.

This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.

This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.

Returns a zero-length WideString on failure

Extracts this ZIP entry beneath the specified base directory.

The entry is extracted according to the relative path stored in the ZIP archive.

For example, if the entry filename is docs/readme.txt and dirPath is c:/temp/output, the file is extracted to c:/temp/output/docs/readme.txt.

Use ExtractInto instead if the file should be extracted directly into a specific directory regardless of the path stored in the ZIP archive.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Extract method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Extracts this entry directly into the specified directory, ignoring any path information stored in the ZIP entry.

For example, if the entry filename is docs/readme.txt and dirPath is c:/temp/output, the file is extracted to c:/temp/output/readme.txt.

If this entry is a directory entry, nothing is extracted. To create the directory represented by a directory entry, use Extract instead.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the ExtractInto method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Updates this ZipEntry object so that it represents the next entry in the same ZIP archive.

The next entry may be either a file entry or a directory entry.

Returns 1 if the object was advanced to the next entry. Returns 0 if there are no more entries.

Updates this ZipEntry object so that it represents the next entry in the ZIP archive matching the specified wildcard pattern.

The wildcard character * matches zero or more characters. Matching is performed against the full stored filename, including any relative path.

The matching entry may be either a file entry or a directory entry.

Returns 1 if a matching entry is found. Returns 0 if no further matching entry exists.

Inflates this ZIP entry directly into memory and returns the uncompressed data as a byte array.

This method is used to obtain the uncompressed bytes of a single ZIP entry without extracting it to a file.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

Creates an asynchronous task to call the Inflate method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

Replaces this ZIP entry's existing contents with new binary data.

The new data becomes the complete contents of the entry.

Returns 1 for success, 0 for failure.

Replaces this ZIP entry's existing contents with new text data.

The text is converted to bytes using the character encoding specified by charset, such as utf-8 or ansi.

The resulting bytes become the complete contents of the entry.

Returns 1 for success, 0 for failure.

Sets the last-modified date/time for this ZIP entry.

The dt argument is a CkDateTime object containing the date/time to store for the entry.

Unzips this entry directly into a BinData object.

The uncompressed bytes are written to binData.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the UnzipToBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Unzips this entry as text and appends the result to a StringBuilder.

The srcCharset argument specifies how the uncompressed bytes should be interpreted, such as utf-8, utf-16, or windows-1252.

The lineEndingBehavior argument controls line-ending conversion:

• 0 — leave line endings unchanged.
• 1 — convert all line endings to bare LF.
• 2 — convert all line endings to CRLF.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the UnzipToSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Unzips this entry to a stream.

If called synchronously, the toStream must have a sink, such as a file or another stream object.

If called asynchronously, the foreground thread can read from the stream while the unzip operation writes to it.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the UnzipToStream method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Inflates this entry and returns the uncompressed data as a string.

The srcCharset argument specifies how the uncompressed bytes should be interpreted, such as utf-8, utf-16, or windows-1252.

The lineEndingBehavior argument controls line-ending conversion:

• 0 — leave line endings unchanged.
• 1 — convert all line endings to bare LF.
• 2 — convert all line endings to CRLF.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the UnzipToString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryAbortCheck(ASender: TObject;  out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnAbortCheck := zipentryAbortCheck;
  // ...

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to 1. This will cause the method to terminate and return a failure status or corresponding failure value.

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryPercentDone(ASender: TObject;  pctDone: Integer; out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnPercentDone := zipentryPercentDone;
  // ...

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryProgressInfo(ASender: TObject;  const name: WideString; const value: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnProgressInfo := zipentryProgressInfo;
  // ...

Called from the background thread when an asynchronous task completes.

Delphi ActiveX Event callback implementation:

procedure TForm1.zipentryTaskCompleted(ASender: TObject;  const task: IChilkatTask);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  zipentry: TChilkatZipEntry;

begin
  zipentry := TChilkatZipEntry.Create(Self);
  zipentry.OnTaskCompleted := zipentryTaskCompleted;
  // ...

This method is deprecated and will be removed in a future version. Use the FileDateTimeStr property instead. Returns the last-modified date/time of this zip entry.

Returns nil on failure

This method is deprecated. Applications should instead call GetNext.

Return the next entry (file or directory) within the Zip

Returns nil on failure

This method is deprecated. Applications should instead call GetNextMatch.

Returns the next entry having a filename matching a pattern. The * characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern. A NULL is returned if nothing matches.

Returns nil on failure