--- product: Chilkat product_version: 11.7.0 language: pascal language_label: Lazarus Pascal class: ZipEntry license: bundle deprecated: false reference_html: https://www.chilkatsoft.com/refdoc/pascal_ZipEntryRef.html --- # Chilkat ZipEntry — Lazarus Pascal — v11.7.0 > Chilkat 11.7.0 · language=pascal · class=ZipEntry > Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0//classes/ZipEntry.md`. > Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/guide.md`. ## Purpose **Inspect, extract, update, and iterate individual entries inside a ZIP archive.** `Chilkat.ZipEntry` represents a single item associated with a `Chilkat.Zip` archive. An entry may be a file already stored in an opened ZIP, a referenced filesystem file waiting to be compressed, an in-memory text or binary entry, or a directory entry. It provides access to entry-level metadata, compressed and uncompressed data, timestamps, attributes, CRC values, encryption information, and extraction or replacement operations for that specific ZIP item. **Entry metadata** Inspect filenames, stored ZIP paths, comments, timestamps, CRC values, attributes, sizes, compression method, and compression level. **Entry type and state** Use `EntryType` to understand whether the entry comes from an existing ZIP, a filesystem reference, memory data, or a directory. **Extract one entry** Extract a selected file entry to disk, inflate its contents into memory, or read the uncompressed data into Chilkat objects. **Read compressed data** Access the raw compressed entry data when an application needs ZIP-level control rather than only the inflated contents. **Replace or append data** Update an entry's contents from strings, byte data, files, or in-memory data sources before writing the ZIP archive. **Iterate archive entries** Walk through entries returned from `Chilkat.Zip` methods to inspect, filter, extract, or modify ZIP contents one item at a time. **Common pattern:** Open or create a `Chilkat.Zip` object, obtain a `ZipEntry` using methods such as `EntryAt`, `EntryOf`, `EntryMatching`, or `FirstEntry`, then inspect metadata, extract contents, update the entry, or continue iterating through the archive. Use `Chilkat.Zip` for whole-archive operations and `ZipEntry` for operations on one specific archive item. For an extended overview, see [ZipEntry Overview](https://www.chilkatsoft.com/zipEntry_overview.asp). ## Object creation, unlocking and error handling **Create / Free** ```pascal uses Chilkat.ZipEntry; var obj: TZipEntry; begin obj := TZipEntry.Create; try if not obj.IsValid then raise Exception.Create('Failed to create a TZipEntry instance.'); // ... use obj ... finally obj.Free; end; end; ``` `constructor Create;` Allocates the underlying CkZipEntry object and returns a new TZipEntry instance. Simply adding **Chilkat.ZipEntry** to the unit's `uses` clause is enough to locate and bind to the Chilkat shared library (DLL / .so / .dylib) at runtime — no separate load step is required. Check `obj.IsValid` after calling `Create`; it is `False` if the underlying library could not be found/loaded or the object could not be allocated (for example, when unlicensed). `destructor Destroy; override;` Every TZipEntry created by calling `Create` should eventually be released by calling `.Free` (inherited from `TObject`). The destructor automatically disposes the underlying CkZipEntry handle. A native (unmanaged) memory leak occurs if the object is never freed. Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in Lazarus Pascal. ## Members common to every Chilkat class Documented once per language in `common-members.md`; listed here so this page is self-contained. | Property | Signature | Access | Meaning | |---|---|---|---| | `DebugLogFilePath` | `property DebugLogFilePath: string read GetDebugLogFilePath write SetDebugLogFilePath;` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. | | `LastErrorHtml` | `property LastErrorHtml: string read GetLastErrorHtml;` | read-only | Provides HTML-formatted information about the last called method or property. | | `LastErrorText` | `property LastErrorText: string read GetLastErrorText;` | read-only | Provides plain text information about the last called method or property. | | `LastErrorXml` | `property LastErrorXml: string read GetLastErrorXml;` | read-only | Provides XML-formatted information about the last called method or property. | | `LastMethodSuccess` | `property LastMethodSuccess: Boolean read GetLastMethodSuccess write SetLastMethodSuccess;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. | | `VerboseLogging` | `property VerboseLogging: Boolean read GetVerboseLogging write SetVerboseLogging;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. | | `Version` | `property Version: string read GetVersion;` | read-only | Version of the component/library, such as "10.1.0" | ## Member index | Member | Kind | Signature | |---|---|---| | `Comment` | property, read/write | `property Comment: string read GetComment write SetComment;` | | `CompressedLength` | property, read-only | `property CompressedLength: LongWord read GetCompressedLength;` | | `CompressedLength64` | property, read-only | `property CompressedLength64: Int64 read GetCompressedLength64;` | | `CompressedLengthStr` | property, read-only | `property CompressedLengthStr: string read GetCompressedLengthStr;` | | `CompressionLevel` | property, read/write | `property CompressionLevel: Integer read GetCompressionLevel write SetCompressionLevel;` | | `CompressionMethod` | property, read/write | `property CompressionMethod: Integer read GetCompressionMethod write SetCompressionMethod;` | | `Crc` | property, read-only | `property Crc: Integer read GetCrc;` | | `EncryptionKeyLen` | property, read-only | `property EncryptionKeyLen: Integer read GetEncryptionKeyLen;` | | `EntryID` | property, read-only | `property EntryID: Integer read GetEntryID;` | | `EntryType` | property, read-only | `property EntryType: Integer read GetEntryType;` | | `FileDateTimeStr` | property, read/write | `property FileDateTimeStr: string read GetFileDateTimeStr write SetFileDateTimeStr;` | | `FileName` | property, read/write | `property FileName: string read GetFileName write SetFileName;` | | `FileNameHex` | property, read-only | `property FileNameHex: string read GetFileNameHex;` | | `HeartbeatMs` | property, read/write | `property HeartbeatMs: Integer read GetHeartbeatMs write SetHeartbeatMs;` | | `IsAesEncrypted` | property, read-only | `property IsAesEncrypted: Boolean read GetIsAesEncrypted;` | | `IsDirectory` | property, read-only | `property IsDirectory: Boolean read GetIsDirectory;` | | `TextFlag` | property, read/write | `property TextFlag: Boolean read GetTextFlag write SetTextFlag;` | | `UncompressedLength` | property, read-only | `property UncompressedLength: LongWord read GetUncompressedLength;` | | `UncompressedLength64` | property, read-only | `property UncompressedLength64: Int64 read GetUncompressedLength64;` | | `UncompressedLengthStr` | property, read-only | `property UncompressedLengthStr: string read GetUncompressedLengthStr;` | | `AppendString` | method | `function AppendString(const strContent: string;     const charset: string): Boolean;` | | `CopyToBase64` | method | `function CopyToBase64: string;` | | `CopyToHex` | method | `function CopyToHex: string;` | | `Extract` | method | `function Extract(const dirPath: string): Boolean;` | | `ExtractInto` | method | `function ExtractInto(const dirPath: string): Boolean;` | | `GetNext` | method | `function GetNext: Boolean;` | | `GetNextMatch` | method | `function GetNextMatch(const pattern: string): Boolean;` | | `LoadTaskCaller` | method | `// task is a TTask object. function LoadTaskCaller(task: TChilkatBase): Boolean;` | | `ReplaceString` | method | `function ReplaceString(const strContent: string;     const charset: string): Boolean;` | | `SetDt` | method | `// dt is a TCkDateTime object. procedure SetDt(dt: TChilkatBase);` | | `UnzipToBd` | method | `// binData is a TBinData object. function UnzipToBd(binData: TChilkatBase): Boolean;` | | `UnzipToSb` | method | `// sb is a TStringBuilder object. function UnzipToSb(lineEndingBehavior: Integer;     const srcCharset: string;     sb: TChilkatBase): Boolean;` | | `UnzipToStream` | method | `// toStream is a TStream object. function UnzipToStream(toStream: TChilkatBase): Boolean;` | | `UnzipToString` | method | `function UnzipToString(lineEndingBehavior: Integer;     const srcCharset: string): string;` | ## Properties ### ZipEntry.Comment `Chilkat 11.7.0 · pascal · ZipEntry · Comment · property · read/write` ```pascal property Comment: string read GetComment write SetComment; ``` Gets or sets the comment stored in the ZIP archive for this entry. ### ZipEntry.CompressedLength `Chilkat 11.7.0 · pascal · ZipEntry · CompressedLength · property · read-only` ```pascal property CompressedLength: LongWord read GetCompressedLength; ``` 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. ### ZipEntry.CompressedLength64 `Chilkat 11.7.0 · pascal · ZipEntry · CompressedLength64 · property · read-only` ```pascal property CompressedLength64: Int64 read GetCompressedLength64; ``` The compressed size of this entry, in bytes, as a 64-bit integer. 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. Use this property when sizes may exceed the range of a 32-bit integer. ### ZipEntry.CompressedLengthStr `Chilkat 11.7.0 · pascal · ZipEntry · CompressedLengthStr · property · read-only` ```pascal property CompressedLengthStr: string read GetCompressedLengthStr; ``` 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. ### ZipEntry.CompressionLevel `Chilkat 11.7.0 · pascal · ZipEntry · CompressionLevel · property · read/write` ```pascal property CompressionLevel: Integer read GetCompressionLevel write SetCompressionLevel; ``` 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`. ### ZipEntry.CompressionMethod `Chilkat 11.7.0 · pascal · ZipEntry · CompressionMethod · property · read/write` ```pascal property CompressionMethod: Integer read GetCompressionMethod write SetCompressionMethod; ``` 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. ### ZipEntry.Crc `Chilkat 11.7.0 · pascal · ZipEntry · Crc · property · read-only` ```pascal property Crc: Integer read GetCrc; ``` The CRC value for this ZIP entry. For AES-encrypted entries, the CRC value is `0`. ### ZipEntry.EncryptionKeyLen `Chilkat 11.7.0 · pascal · ZipEntry · EncryptionKeyLen · property · read-only · since 9.5.0.69` ```pascal property EncryptionKeyLen: Integer read GetEncryptionKeyLen; ``` 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`. ### ZipEntry.EntryID `Chilkat 11.7.0 · pascal · ZipEntry · EntryID · property · read-only` ```pascal property EntryID: Integer read GetEntryID; ``` 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`. ### ZipEntry.EntryType `Chilkat 11.7.0 · pascal · ZipEntry · EntryType · property · read-only` ```pascal property EntryType: Integer read GetEntryType; ``` 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. ### ZipEntry.FileDateTimeStr `Chilkat 11.7.0 · pascal · ZipEntry · FileDateTimeStr · property · read/write` ```pascal property FileDateTimeStr: string read GetFileDateTimeStr write SetFileDateTimeStr; ``` 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`. ### ZipEntry.FileName `Chilkat 11.7.0 · pascal · ZipEntry · FileName · property · read/write` ```pascal property FileName: string read GetFileName write SetFileName; ``` 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. ### ZipEntry.FileNameHex `Chilkat 11.7.0 · pascal · ZipEntry · FileNameHex · property · read-only` ```pascal property FileNameHex: string read GetFileNameHex; ``` Returns the raw filename bytes found in the ZIP entry, encoded as a hexadecimal string. This can be useful for diagnosing filename encoding issues. ### ZipEntry.HeartbeatMs `Chilkat 11.7.0 · pascal · ZipEntry · HeartbeatMs · property · read/write` ```pascal property HeartbeatMs: Integer read GetHeartbeatMs write SetHeartbeatMs; ``` **Full documentation for this property (same in every language):** [Event Callback Examples](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/event_callback_examples.md) 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.** ### ZipEntry.IsAesEncrypted `Chilkat 11.7.0 · pascal · ZipEntry · IsAesEncrypted · property · read-only · since 9.5.0.69` ```pascal property IsAesEncrypted: Boolean read GetIsAesEncrypted; ``` Indicates whether this ZIP entry is AES encrypted. This property can be `True` 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 `False`. ### ZipEntry.IsDirectory `Chilkat 11.7.0 · pascal · ZipEntry · IsDirectory · property · read-only` ```pascal property IsDirectory: Boolean read GetIsDirectory; ``` Indicates whether this ZIP entry is a directory entry. The value is `True` if the entry represents a directory, and `False` if it represents a file. ### ZipEntry.TextFlag `Chilkat 11.7.0 · pascal · ZipEntry · TextFlag · property · read/write` ```pascal property TextFlag: Boolean read GetTextFlag write SetTextFlag; ``` 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. ### ZipEntry.UncompressedLength `Chilkat 11.7.0 · pascal · ZipEntry · UncompressedLength · property · read-only` ```pascal property UncompressedLength: LongWord read GetUncompressedLength; ``` The uncompressed size of this entry, in bytes. ### ZipEntry.UncompressedLength64 `Chilkat 11.7.0 · pascal · ZipEntry · UncompressedLength64 · property · read-only` ```pascal property UncompressedLength64: Int64 read GetUncompressedLength64; ``` The uncompressed size of this entry, in bytes, as a 64-bit integer. Use this property when the uncompressed size may exceed the range of a 32-bit integer. ### ZipEntry.UncompressedLengthStr `Chilkat 11.7.0 · pascal · ZipEntry · UncompressedLengthStr · property · read-only` ```pascal property UncompressedLengthStr: string read GetUncompressedLengthStr; ``` 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. ## Methods ### ZipEntry.AppendString `Chilkat 11.7.0 · pascal · ZipEntry · AppendString · method` ```pascal function AppendString(const strContent: string;     const charset: string): Boolean; ``` 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 True for success, False for failure. ### ZipEntry.CopyToBase64 `Chilkat 11.7.0 · pascal · ZipEntry · CopyToBase64 · method` ```pascal function CopyToBase64: string; ``` 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 True for success, False for failure. ### ZipEntry.CopyToHex `Chilkat 11.7.0 · pascal · ZipEntry · CopyToHex · method` ```pascal function CopyToHex: string; ``` 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 True for success, False for failure. ### ZipEntry.Extract `Chilkat 11.7.0 · pascal · ZipEntry · Extract · method` ```pascal function Extract(const dirPath: string): Boolean; ``` 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 True for success, False for failure. ### ZipEntry.ExtractInto `Chilkat 11.7.0 · pascal · ZipEntry · ExtractInto · method` ```pascal function ExtractInto(const dirPath: string): Boolean; ``` 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 True for success, False for failure. ### ZipEntry.GetNext `Chilkat 11.7.0 · pascal · ZipEntry · GetNext · method · since 11.0.0` ```pascal function GetNext: Boolean; ``` 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 `True` if the object was advanced to the next entry. Returns `False` if there are no more entries. ### ZipEntry.GetNextMatch `Chilkat 11.7.0 · pascal · ZipEntry · GetNextMatch · method · since 11.0.0` ```pascal function GetNextMatch(const pattern: string): Boolean; ``` 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 `True` if a matching entry is found. Returns `False` if no further matching entry exists. ### ZipEntry.LoadTaskCaller `Chilkat 11.7.0 · pascal · ZipEntry · LoadTaskCaller · method · since 9.5.0.80` ```pascal // task is a TTask object. function LoadTaskCaller(task: TChilkatBase): Boolean; ``` Loads the caller of the task's async method. Returns True for success, False for failure. ### ZipEntry.ReplaceString `Chilkat 11.7.0 · pascal · ZipEntry · ReplaceString · method` ```pascal function ReplaceString(const strContent: string;     const charset: string): Boolean; ``` 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 True for success, False for failure. ### ZipEntry.SetDt `Chilkat 11.7.0 · pascal · ZipEntry · SetDt · method` ```pascal // dt is a TCkDateTime object. procedure SetDt(dt: TChilkatBase); ``` 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. ### ZipEntry.UnzipToBd `Chilkat 11.7.0 · pascal · ZipEntry · UnzipToBd · method · since 9.5.0.67` ```pascal // binData is a TBinData object. function UnzipToBd(binData: TChilkatBase): Boolean; ``` Unzips this entry directly into a `BinData` object. The uncompressed bytes are written to `binData`. Returns True for success, False for failure. ### ZipEntry.UnzipToSb `Chilkat 11.7.0 · pascal · ZipEntry · UnzipToSb · method · since 9.5.0.67` ```pascal // sb is a TStringBuilder object. function UnzipToSb(lineEndingBehavior: Integer;     const srcCharset: string;     sb: TChilkatBase): Boolean; ``` 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 True for success, False for failure. ### ZipEntry.UnzipToStream `Chilkat 11.7.0 · pascal · ZipEntry · UnzipToStream · method · since 9.5.0.67` ```pascal // toStream is a TStream object. function UnzipToStream(toStream: TChilkatBase): Boolean; ``` 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 True for success, False for failure. ### ZipEntry.UnzipToString `Chilkat 11.7.0 · pascal · ZipEntry · UnzipToString · method` ```pascal function UnzipToString(lineEndingBehavior: Integer;     const srcCharset: string): string; ``` 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 True for success, False for failure. ## Events and callbacks Chilkat for Pascal supports three synchronous event callbacks: `OnAbortCheck`, `OnPercentDone`, and `OnProgressInfo`. Each is a property of the class; assign a method of one of your own objects (an *of object* handler) to receive the callbacks, or assign `nil` to unhook. The handler types are declared in the `Chilkat.Base` unit: ```pascal TChilkatAbortCheckEvent = function(Sender: TChilkatBase): Boolean of object; TChilkatPercentDoneEvent = function(Sender: TChilkatBase; PctDone: Integer): Boolean of object; TChilkatProgressInfoEvent = procedure(Sender: TChilkatBase; const Name, Value: string) of object; ``` All Chilkat methods are synchronous, so callbacks are invoked on the thread that called the method -- if the method was called from the main thread, it is safe to access UI elements from the handler. The `HeartbeatMs` property controls the frequency of `OnAbortCheck` callbacks (the default of 0 means no AbortCheck events fire). Returning `True` from an `OnAbortCheck` or `OnPercentDone` handler aborts the running method. ### ZipEntry.AbortCheck (event) `Chilkat 11.7.0 · pascal · ZipEntry · AbortCheck · event` ```pascal // TChilkatAbortCheckEvent = function(Sender: TChilkatBase): Boolean of object; property OnAbortCheck: TChilkatAbortCheckEvent; ``` 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. **Event callback implementation:** ```pascal // A handler is a method of one of your own classes, e.g. a form: function TMyObject.ZipEntryAbortCheck(Sender: TChilkatBase): Boolean; begin // Called every HeartbeatMs milliseconds while a method is running. // Return True to abort the method; return False to continue. Result := False; end; ``` **To add an event handler:** ```pascal zipentry := TZipEntry.Create; zipentry.HeartbeatMs := 250; // fire OnAbortCheck 4 times per second zipentry.OnAbortCheck := MyObject.ZipEntryAbortCheck; ``` ### ZipEntry.PercentDone (event) `Chilkat 11.7.0 · pascal · ZipEntry · PercentDone · event` ```pascal // TChilkatPercentDoneEvent = function(Sender: TChilkatBase; PctDone: Integer): Boolean of object; property OnPercentDone: TChilkatPercentDoneEvent; ``` 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 `True`. This will cause the method to terminate and return a failure status or corresponding failure value. **Event callback implementation:** ```pascal // A handler is a method of one of your own classes, e.g. a form: function TMyObject.ZipEntryPercentDone(Sender: TChilkatBase; PctDone: Integer): Boolean; begin // PctDone ranges from 1 to 100. WriteLn('Percent done: ', PctDone); // Return True to abort the method; return False to continue. Result := False; end; ``` **To add an event handler:** ```pascal zipentry := TZipEntry.Create; zipentry.OnPercentDone := MyObject.ZipEntryPercentDone; ``` ### ZipEntry.ProgressInfo (event) `Chilkat 11.7.0 · pascal · ZipEntry · ProgressInfo · event` ```pascal // TChilkatProgressInfoEvent = procedure(Sender: TChilkatBase; const Name, Value: string) of object; property OnProgressInfo: TChilkatProgressInfoEvent; ``` 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. Note: Some Chilkat methods don't fire any ProgressInfo events. **Event callback implementation:** ```pascal // A handler is a method of one of your own classes, e.g. a form: procedure TMyObject.ZipEntryProgressInfo(Sender: TChilkatBase; const Name, Value: string); begin WriteLn(Name, ': ', Value); end; ``` **To add an event handler:** ```pascal zipentry := TZipEntry.Create; zipentry.OnProgressInfo := MyObject.ZipEntryProgressInfo; ``` ## Related classes [`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/CkDateTime.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/Stream.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/StringBuilder.md)