---
product: Chilkat
product_version: 11.7.0
language: pascal
language_label: Lazarus Pascal
class: Zip
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/pascal_ZipRef.html
---
# Chilkat Zip — Lazarus Pascal — v11.7.0

> Chilkat 11.7.0 · language=pascal · class=Zip
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Zip.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/guide.md`.

## Purpose

**Create, read, modify, encrypt, and extract ZIP archives.**

`Chilkat.Zip` provides a comprehensive API for working with ZIP archives from files, memory, `BinData`, embedded resources, and Windows self-extracting EXEs. It can create new archives, open existing ZIPs, add files or in-memory data, inspect entries, extract selectively, and write the final archive to disk or memory.

**Create ZIP archives**

Add files, directories, strings, byte arrays, `BinData`, and `StringBuilder` content.

**Open ZIPs from many sources**

Open archives from disk, memory, `BinData`, embedded Windows resources, or Chilkat-created self-extracting EXEs.

**Control stored paths**

Use options such as `AppendFromDir`, `DiscardPaths`, `PathPrefix`, and `saveExtraPath`.

**Extract selectively**

Extract all files, matching entries, newer files, or flatten all output into a single directory.

**Encryption support**

Work with WinZip-compatible AES encryption and legacy Zip 2.0 password protection.

**Large archive support**

ZIP64 is used automatically when older ZIP limits are exceeded.

**Important:** Many methods update the in-memory ZIP object first. The archive is not written until a method such as `WriteZip`, `WriteZipAndClose`, `WriteBd`, or `WriteToMemory` is called.

For an extended overview, see [Zip Class Overview](https://www.chilkatsoft.com/zip_class_overview.asp).

## Object creation, unlocking and error handling

**Create / Free**

```pascal
uses
  Chilkat.Zip;

var
  obj: TZip;
begin
  obj := TZip.Create;
  try
    if not obj.IsValid then
      raise Exception.Create('Failed to create a TZip instance.');

    // ... use obj ...

  finally
    obj.Free;
  end;
end;
```

`constructor Create;`

Allocates the underlying CkZip object and returns a new TZip instance. Simply adding **Chilkat.Zip** 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 TZip created by calling `Create` should eventually be released by calling `.Free` (inherited from `TObject`). The destructor automatically disposes the underlying CkZip 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 |
|---|---|---|
| `AbortCurrent` | property, read/write | `property AbortCurrent: Boolean read GetAbortCurrent write SetAbortCurrent;` |
| `AppendFromDir` | property, read/write | `property AppendFromDir: string read GetAppendFromDir write SetAppendFromDir;` |
| `AutoRun` | property, read/write | `property AutoRun: string read GetAutoRun write SetAutoRun;` |
| `AutoRunParams` | property, read/write | `property AutoRunParams: string read GetAutoRunParams write SetAutoRunParams;` |
| `AutoTemp` | property, read/write | `property AutoTemp: Boolean read GetAutoTemp write SetAutoTemp;` |
| `CaseSensitive` | property, read/write | `property CaseSensitive: Boolean read GetCaseSensitive write SetCaseSensitive;` |
| `ClearArchiveAttribute` | property, read/write | `property ClearArchiveAttribute: Boolean read GetClearArchiveAttribute write SetClearArchiveAttribute;` |
| `ClearReadOnlyAttr` | property, read/write | `property ClearReadOnlyAttr: Boolean read GetClearReadOnlyAttr write SetClearReadOnlyAttr;` |
| `Comment` | property, read/write | `property Comment: string read GetComment write SetComment;` |
| `DecryptPassword` | property, read/write | `property DecryptPassword: string read GetDecryptPassword write SetDecryptPassword;` |
| `DiscardPaths` | property, read/write | `property DiscardPaths: Boolean read GetDiscardPaths write SetDiscardPaths;` |
| `Encryption` | property, read/write | `property Encryption: Integer read GetEncryption write SetEncryption;` |
| `EncryptKeyLength` | property, read/write | `property EncryptKeyLength: Integer read GetEncryptKeyLength write SetEncryptKeyLength;` |
| `EncryptPassword` | property, read/write | `property EncryptPassword: string read GetEncryptPassword write SetEncryptPassword;` |
| `ExeDefaultDir` | property, read/write | `property ExeDefaultDir: string read GetExeDefaultDir write SetExeDefaultDir;` |
| `ExeFinishNotifier` | property, read/write | `property ExeFinishNotifier: Boolean read GetExeFinishNotifier write SetExeFinishNotifier;` |
| `ExeIconFile` | property, read/write | `property ExeIconFile: string read GetExeIconFile write SetExeIconFile;` |
| `ExeNoInterface` | property, read/write | `property ExeNoInterface: Boolean read GetExeNoInterface write SetExeNoInterface;` |
| `ExeSilentProgress` | property, read/write | `property ExeSilentProgress: Boolean read GetExeSilentProgress write SetExeSilentProgress;` |
| `ExeTitle` | property, read/write | `property ExeTitle: string read GetExeTitle write SetExeTitle;` |
| `ExeUnzipCaption` | property, read/write | `property ExeUnzipCaption: string read GetExeUnzipCaption write SetExeUnzipCaption;` |
| `ExeUnzipDir` | property, read/write | `property ExeUnzipDir: string read GetExeUnzipDir write SetExeUnzipDir;` |
| `ExeWaitForSetup` | property, read/write | `property ExeWaitForSetup: Boolean read GetExeWaitForSetup write SetExeWaitForSetup;` |
| `ExeXmlConfig` | property, read/write | `property ExeXmlConfig: string read GetExeXmlConfig write SetExeXmlConfig;` |
| `FileCount` | property, read-only | `property FileCount: Integer read GetFileCount;` |
| `FileName` | property, read/write | `property FileName: string read GetFileName write SetFileName;` |
| `HasZipFormatErrors` | property, read-only | `property HasZipFormatErrors: Boolean read GetHasZipFormatErrors;` |
| `HeartbeatMs` | property, read/write | `property HeartbeatMs: Integer read GetHeartbeatMs write SetHeartbeatMs;` |
| `IgnoreAccessDenied` | property, read/write | `property IgnoreAccessDenied: Boolean read GetIgnoreAccessDenied write SetIgnoreAccessDenied;` |
| `MaxDate` | property, read/write | `property MaxDate: string read GetMaxDate write SetMaxDate;` |
| `MaxUncompressSize` | property, read/write | `property MaxUncompressSize: LongWord read GetMaxUncompressSize write SetMaxUncompressSize;` |
| `MinDate` | property, read/write | `property MinDate: string read GetMinDate write SetMinDate;` |
| `NumEntries` | property, read-only | `property NumEntries: Integer read GetNumEntries;` |
| `OemCodePage` | property, read/write | `property OemCodePage: Integer read GetOemCodePage write SetOemCodePage;` |
| `OverwriteExisting` | property, read/write | `property OverwriteExisting: Boolean read GetOverwriteExisting write SetOverwriteExisting;` |
| `PasswordProtect` | property, read/write | `property PasswordProtect: Boolean read GetPasswordProtect write SetPasswordProtect;` |
| `PathPrefix` | property, read/write | `property PathPrefix: string read GetPathPrefix write SetPathPrefix;` |
| `PercentDoneScale` | property, read/write | `property PercentDoneScale: Integer read GetPercentDoneScale write SetPercentDoneScale;` |
| `PwdProtCharset` | property, read/write | `property PwdProtCharset: string read GetPwdProtCharset write SetPwdProtCharset;` |
| `TempDir` | property, read/write | `property TempDir: string read GetTempDir write SetTempDir;` |
| `UncommonOptions` | property, read/write | `property UncommonOptions: string read GetUncommonOptions write SetUncommonOptions;` |
| `Zipx` | property, read/write | `property Zipx: Boolean read GetZipx write SetZipx;` |
| `ZipxDefaultAlg` | property, read/write | `property ZipxDefaultAlg: string read GetZipxDefaultAlg write SetZipxDefaultAlg;` |
| `AddBd` | method | `// bd is a TBinData object. function AddBd(const pathInZip: string;     bd: TChilkatBase): Boolean;` |
| `AddEmpty` | method | `function AddEmpty(isDir: Boolean;     const pathInZip: string): Boolean;` |
| `AddEncoded` | method | `function AddEncoded(const pathInZip: string;     const encoding: string;     const data: string): Boolean;` |
| `AddFile` | method | `function AddFile(const localPath: string;     saveExtraPath: Boolean): Boolean;` |
| `AddNoCompressExtension` | method | `procedure AddNoCompressExtension(const fileExtension: string);` |
| `AddSb` | method | `// sb is a TStringBuilder object. function AddSb(const pathInZip: string;     sb: TChilkatBase;     const charset: string): Boolean;` |
| `AddString` | method | `function AddString(const pathInZip: string;     const content: string;     const charset: string): Boolean;` |
| `AppendFiles` | method | `function AppendFiles(const filePattern: string;     recurse: Boolean): Boolean;` |
| `AppendFilesEx` | method | `function AppendFilesEx(const filePattern: string;     recurse: Boolean;     saveExtraPath: Boolean;     archiveOnly: Boolean;     includeHidden: Boolean;     includeSystem: Boolean): Boolean;` |
| `AppendZip` | method | `function AppendZip(const zipPath: string): Boolean;` |
| `CloseZip` | method | `procedure CloseZip;` |
| `DeleteEntry` | method | `// entry is a TZipEntry object. function DeleteEntry(entry: TChilkatBase): Boolean;` |
| `EntryAt` | method | `// entry is a TZipEntry object. function EntryAt(index: Integer;     entry: TChilkatBase): Boolean;` |
| `EntryById` | method | `// entry is a TZipEntry object. function EntryById(id: Integer;     entry: TChilkatBase): Boolean;` |
| `EntryMatching` | method | `// entry is a TZipEntry object. function EntryMatching(const pattern: string;     entry: TChilkatBase): Boolean;` |
| `EntryOf` | method | `// entry is a TZipEntry object. function EntryOf(const pathInZip: string;     entry: TChilkatBase): Boolean;` |
| `ExcludeDir` | method | `procedure ExcludeDir(const dirName: string);` |
| `ExtractExe` | method | `function ExtractExe(const exePath: string;     const dirPath: string): Boolean;` |
| `GetDirectoryAsXML` | method | `function GetDirectoryAsXML: string;` |
| `GetExeConfigParam` | method | `function GetExeConfigParam(const name: string): string;` |
| `GetMaxUncompressedSize` | method | `function GetMaxUncompressedSize: string;` |
| `IsNoCompressExtension` | method | `function IsNoCompressExtension(const fileExtension: string): Boolean;` |
| `IsPasswordProtected` | method | `function IsPasswordProtected(const zipPath: string): Boolean;` |
| `LoadTaskCaller` | method | `// task is a TTask object. function LoadTaskCaller(task: TChilkatBase): Boolean;` |
| `NewZip` | method | `function NewZip(const zipPath: string): Boolean;` |
| `OpenBd` | method | `// binData is a TBinData object. function OpenBd(binData: TChilkatBase): Boolean;` |
| `OpenEmbedded` | method | `function OpenEmbedded(const exeFilename: string;     const resourceName: string): Boolean;` |
| `OpenZip` | method | `function OpenZip(const zipPath: string): Boolean;` |
| `QuickAppend` | method | `function QuickAppend(const zipPath: string): Boolean;` |
| `RemoveNoCompressExtension` | method | `procedure RemoveNoCompressExtension(const fileExtension: string);` |
| `SetCompressionLevel` | method | `procedure SetCompressionLevel(level: Integer);` |
| `SetExclusions` | method | `// excludePatterns is a TStringArray object. procedure SetExclusions(excludePatterns: TChilkatBase);` |
| `SetExeConfigParam` | method | `procedure SetExeConfigParam(const paramName: string;     const paramValue: string);` |
| `Unzip` | method | `function Unzip(const dirPath: string): Integer;` |
| `UnzipInto` | method | `function UnzipInto(const dirPath: string): Integer;` |
| `UnzipMatching` | method | `function UnzipMatching(const dirPath: string;     const pattern: string;     verbose: Boolean): Integer;` |
| `UnzipMatchingInto` | method | `function UnzipMatchingInto(const dirPath: string;     const pattern: string;     verbose: Boolean): Integer;` |
| `UnzipNewer` | method | `function UnzipNewer(const dirPath: string): Integer;` |
| `VerifyPassword` | method | `function VerifyPassword: Boolean;` |
| `WriteBd` | method | `// binData is a TBinData object. function WriteBd(binData: TChilkatBase): Boolean;` |
| `WriteExe` | method | `function WriteExe(const exeFilename: string): Boolean;` |
| `WriteZip` | method | `function WriteZip: Boolean;` |
| `WriteZipAndClose` | method | `function WriteZipAndClose: Boolean;` |

## Properties

### Zip.AbortCurrent

`Chilkat 11.7.0 · pascal · Zip · AbortCurrent · property · read/write · since 9.5.0.58`

```pascal
property AbortCurrent: Boolean read GetAbortCurrent write SetAbortCurrent;
```

Stops the currently executing operation when set to `True`.

- Used to cancel long-running operations such as compression or extraction.
- Can be triggered from another thread.
- Automatically resets to `False` after the operation stops.

### Zip.AppendFromDir

`Chilkat 11.7.0 · pascal · Zip · AppendFromDir · property · read/write`

```pascal
property AppendFromDir: string read GetAppendFromDir write SetAppendFromDir;
```

Specifies a base directory when adding files to the ZIP.

- This portion of the path is **not included** in stored ZIP entry paths.
- Useful for controlling relative paths inside the archive.

For example, to add all files under `c:/abc/123/myAppDir`, this property could be set to `c:/abc/123`, and `myAppDir/*` would be passed to `AppendFiles`.

The path stored in the ZIP would begin with `myAppDir/`.

### Zip.AutoRun

`Chilkat 11.7.0 · pascal · Zip · AutoRun · property · read/write`

```pascal
property AutoRun: string read GetAutoRun write SetAutoRun;
```

`(Windows only, for creating self-extracting EXE's)`

Specifies the name of an executable inside a self-extracting EXE that runs automatically after extraction.

### Zip.AutoRunParams

`Chilkat 11.7.0 · pascal · Zip · AutoRunParams · property · read/write`

```pascal
property AutoRunParams: string read GetAutoRunParams write SetAutoRunParams;
```

`(Windows only, for creating self-extracting EXE's)`

Command-line arguments passed to the `AutoRun` executable.

### Zip.AutoTemp

`Chilkat 11.7.0 · pascal · Zip · AutoTemp · property · read/write`

```pascal
property AutoTemp: Boolean read GetAutoTemp write SetAutoTemp;
```

`(Windows only, for creating self-extracting EXE's)`

If `True`, the EXE being created will automatically select and create a temporary directory for unzipping.

This property is often used together with `AutoRun` to create a self-extracting EXE that automatically unzips to a temporary directory and runs a setup program, such as `setup.exe`, without user interaction.

**Note:** To create a self-extracting EXE with no user interaction, set the following properties:

> `ExeSilentProgress = False`  
> `ExeNoInterface = True`  
> `ExeFinishNotifier = False`

The default value is `False`.

### Zip.CaseSensitive

`Chilkat 11.7.0 · pascal · Zip · CaseSensitive · property · read/write`

```pascal
property CaseSensitive: Boolean read GetCaseSensitive write SetCaseSensitive;
```

Controls whether filename matching is case-sensitive.

- Affects methods such as `EntryMatching` and `UnzipMatching`.
- Default: `False`

### Zip.ClearArchiveAttribute

`Chilkat 11.7.0 · pascal · Zip · ClearArchiveAttribute · property · read/write`

```pascal
property ClearArchiveAttribute: Boolean read GetClearArchiveAttribute write SetClearArchiveAttribute;
```

`(Windows only)`

If `True`, clears the Windows archive attribute after files are successfully added to the ZIP.

The archive attribute indicates that a file has changed since the last backup.

The default value is `False`.

### Zip.ClearReadOnlyAttr

`Chilkat 11.7.0 · pascal · Zip · ClearReadOnlyAttr · property · read/write`

```pascal
property ClearReadOnlyAttr: Boolean read GetClearReadOnlyAttr write SetClearReadOnlyAttr;
```

If `True`, removes the read-only attribute from extracted files.

If `False`, the read-only attribute remains unchanged.

The default value is `False`.

### Zip.Comment

`Chilkat 11.7.0 · pascal · Zip · Comment · property · read/write`

```pascal
property Comment: string read GetComment write SetComment;
```

Sets or retrieves the global ZIP file comment.

The default value is the empty string.

### Zip.DecryptPassword

`Chilkat 11.7.0 · pascal · Zip · DecryptPassword · property · read/write`

```pascal
property DecryptPassword: string read GetDecryptPassword write SetDecryptPassword;
```

Password used to extract encrypted ZIP archives.

- Required to unzip encrypted entries.
- Encrypted ZIP files may still be opened without a password, but their contents cannot be extracted until the correct password is provided.

The default value is the empty string.

### Zip.DiscardPaths

`Chilkat 11.7.0 · pascal · Zip · DiscardPaths · property · read/write`

```pascal
property DiscardPaths: Boolean read GetDiscardPaths write SetDiscardPaths;
```

If `True`, removes all directory path information when adding files.

Only filenames are stored in the ZIP.

The default value is `False`.

### Zip.Encryption

`Chilkat 11.7.0 · pascal · Zip · Encryption · property · read/write`

```pascal
property Encryption: Integer read GetEncryption write SetEncryption;
```

Specifies encryption mode:

- `0` → No encryption
- `4` → WinZip-compatible AES encryption

**Important:** `Encryption` and `PasswordProtect` are mutually exclusive.

If `PasswordProtect = True`, then `Encryption` should be `0`.

The default value is `0`.

### Zip.EncryptKeyLength

`Chilkat 11.7.0 · pascal · Zip · EncryptKeyLength · property · read/write`

```pascal
property EncryptKeyLength: Integer read GetEncryptKeyLength write SetEncryptKeyLength;
```

Specifies the AES encryption key length.

- Valid values: `128`, `192`, or `256`

The default value is `128`.

### Zip.EncryptPassword

`Chilkat 11.7.0 · pascal · Zip · EncryptPassword · property · read/write`

```pascal
property EncryptPassword: string read GetEncryptPassword write SetEncryptPassword;
```

Password used when creating encrypted ZIP archives.

The default value is the empty string.

### Zip.ExeDefaultDir

`Chilkat 11.7.0 · pascal · Zip · ExeDefaultDir · property · read/write`

```pascal
property ExeDefaultDir: string read GetExeDefaultDir write SetExeDefaultDir;
```

`(Windows only, for creating self-extracting EXE's)`

Default extraction directory shown in the self-extracting EXE user interface.

The default value is the empty string.

### Zip.ExeFinishNotifier

`Chilkat 11.7.0 · pascal · Zip · ExeFinishNotifier · property · read/write`

```pascal
property ExeFinishNotifier: Boolean read GetExeFinishNotifier write SetExeFinishNotifier;
```

`(Windows only, for creating self-extracting EXE's)`

If `True`, displays a completion dialog after extraction finishes.

The default value is `False`.

### Zip.ExeIconFile

`Chilkat 11.7.0 · pascal · Zip · ExeIconFile · property · read/write`

```pascal
property ExeIconFile: string read GetExeIconFile write SetExeIconFile;
```

`(Windows only, for creating self-extracting EXE's)`

Path to an `.ico` file used as the EXE icon.

This feature is only available when the application creating the EXE is 32-bit.

The default value is the empty string.

### Zip.ExeNoInterface

`Chilkat 11.7.0 · pascal · Zip · ExeNoInterface · property · read/write`

```pascal
property ExeNoInterface: Boolean read GetExeNoInterface write SetExeNoInterface;
```

`(Windows only, for creating self-extracting EXE's)`

If `True`, runs the self-extracting EXE without displaying the main user interface.

The default value is `False`.

### Zip.ExeSilentProgress

`Chilkat 11.7.0 · pascal · Zip · ExeSilentProgress · property · read/write`

```pascal
property ExeSilentProgress: Boolean read GetExeSilentProgress write SetExeSilentProgress;
```

`(Windows only, for creating self-extracting EXE's)`

Controls whether a progress dialog is shown during extraction.

If `ExeNoInterface = False`, the progress bar appears within the main dialog and this property has no effect.

The default value is `False`.

### Zip.ExeTitle

`Chilkat 11.7.0 · pascal · Zip · ExeTitle · property · read/write`

```pascal
property ExeTitle: string read GetExeTitle write SetExeTitle;
```

`(Windows only, for creating self-extracting EXE's)`

Title displayed in the self-extracting EXE dialog.

The default value is the empty string.

### Zip.ExeUnzipCaption

`Chilkat 11.7.0 · pascal · Zip · ExeUnzipCaption · property · read/write`

```pascal
property ExeUnzipCaption: string read GetExeUnzipCaption write SetExeUnzipCaption;
```

`(Windows only, for creating self-extracting EXE's)`

Caption text displayed in the self-extracting EXE dialog.

The default value is the empty string.

### Zip.ExeUnzipDir

`Chilkat 11.7.0 · pascal · Zip · ExeUnzipDir · property · read/write`

```pascal
property ExeUnzipDir: string read GetExeUnzipDir write SetExeUnzipDir;
```

`(Windows only, for creating self-extracting EXE's)`

Specifies a predefined extraction directory.

- Supports environment variables such as `%TEMP%`.
- UNC paths are not supported.

The default value is the empty string.

### Zip.ExeWaitForSetup

`Chilkat 11.7.0 · pascal · Zip · ExeWaitForSetup · property · read/write`

```pascal
property ExeWaitForSetup: Boolean read GetExeWaitForSetup write SetExeWaitForSetup;
```

If `True`, waits for the AutoRun executable to finish before exiting.

If `False`, the self-extracting EXE may exit before the AutoRun executable completes.

The default value is `True`.

### Zip.ExeXmlConfig

`Chilkat 11.7.0 · pascal · Zip · ExeXmlConfig · property · read/write`

```pascal
property ExeXmlConfig: string read GetExeXmlConfig write SetExeXmlConfig;
```

Allows for an XML config document to be used to specify all possible options for self-extracting EXEs. This property is a string containing the XML config document.

The XML should have this format:

\<SfxConfig>

\<ErrPwdTitle>Title for incorrect password dialog\</ErrPwdTitle>

\<ErrPwdCaption>Caption for incorrect password dialog\</ErrPwdCaption>

\<FinOkBtn>Text on finish notifier button\</FinOkBtn>

\<PwdOkBtn>Text on password challenge dialog's "OK" button.\</PwdOkBtn>

\<PwdCancelBtn>Text on password challenge dialog's Cancel button.\</PwdCancelBtn>

\<ErrInvalidPassword>Incorrect password error message.\</ErrInvalidPassword>

\<MainUnzipBtn>Text on main dialog's unzip button. **Note:** The `MainUnzipLabel` must also be set for this to take effect.\</MainUnzipBtn>

\<MainCloseBtn>Text on main dialog's quit/exit button. **Note:** The `MainUnzipLabel` must also be set for this to take effect.\</MainCloseBtn>

\<MainBrowseBtn>Text on main dialog's browse-for-directory button. **Note:** The `MainUnzipLabel` must also be set for this to take effect.\</MainBrowseBtn>

\<MainUnzipLabel>Caption displayed in main dialog.\</MainUnzipLabel>

\<AutoTemp>0 or 1 (Maps to the `AutoTemp` property)\</AutoTemp>

\<Cleanup>0 or 1 (If 1, extracted files are deleted after the `SetupExe` is run.)\</Cleanup>

\<Debug>0 or 1 (If 1, the EXE will not extract any files.)\</Debug>

\<Verbose>0 or 1 (If 1, verbose information is written to the log.)\</Verbose>

\<ShowFin>0 or 1 (Maps to the `ExeFinishNotifier` property)\</ShowFin>

\<ShowMain>0 or 1 (Maps to the `ExeNoInterface` property)\</ShowMain>

\<ShowProgress>0 or 1 (Maps to the `ExeSilentProgress` property)\</ShowProgress>

\<WaitForSetup>0 or 1 (Maps to the `ExeWaitForSetup` property)\</WaitForSetup>

\<Encryption>0 or 1 (1 = Yes, 0 = No)\</Encryption>

\<KeyLength>128\|192\|256\</KeyLength>

\<SetupExe>EXE to run after extracting. (Maps to the `AutoRun` property)\</SetupExe>

\<UnzipDir>Pre-defined unzip directory. (Maps to the `ExeUnzipDir` property. UNC paths, such as \\\\servername\\path, are not supported.)\</UnzipDir>

\<DefaultDir>Default unzip directory to appear in the main dialog. (Maps to the `ExeDefaultDir` property)\</DefaultDir>

\<IconFile>Icon file to be used (Maps to the `ExeIconFile` property)\</IconFile>

\<MainTitle>Maps to the `ExeTitle` property.\</MainTitle>

\<MainCaption>Maps to the `ExeUnzipCaption` property.\</MainCaption>

\<FinTitle>Title for the finish notifier dialog.\</FinTitle>

\<FinCaption>Caption for the finish notifier dialog.\</FinCaption>

\<ProgressTitle>Title for the progress dialog.\</ProgressTitle>

\<ProgressCaption>Caption for the progress dialog.\</ProgressCaption>

\<PwTitle>Title for the password challenge dialog.\</PwTitle>

\<PwCaption>Caption for the password challenge dialog.\</PwCaption>

\</SfxConfig>

A self-extracting EXE can be run from the command line with the `-log {logFilePath}` option to create a log with information for debugging.

### Zip.FileCount

`Chilkat 11.7.0 · pascal · Zip · FileCount · property · read-only`

```pascal
property FileCount: Integer read GetFileCount;
```

Number of files in the ZIP, excluding directory entries.

### Zip.FileName

`Chilkat 11.7.0 · pascal · Zip · FileName · property · read/write`

```pascal
property FileName: string read GetFileName write SetFileName;
```

Path of the ZIP file to be written or overwritten.

The default value is the empty string.

### Zip.HasZipFormatErrors

`Chilkat 11.7.0 · pascal · Zip · HasZipFormatErrors · property · read-only`

```pascal
property HasZipFormatErrors: Boolean read GetHasZipFormatErrors;
```

Indicates whether minor ZIP format problems were detected when opening the ZIP archive.

### Zip.HeartbeatMs

`Chilkat 11.7.0 · pascal · Zip · 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)

Interval, in milliseconds, between abort-check callbacks.

If set to `0`, abort callbacks are disabled.

The default value is `0`.

### Zip.IgnoreAccessDenied

`Chilkat 11.7.0 · pascal · Zip · IgnoreAccessDenied · property · read/write`

```pascal
property IgnoreAccessDenied: Boolean read GetIgnoreAccessDenied write SetIgnoreAccessDenied;
```

If `True`, files that cannot be read, written, or created due to filesystem permission errors are skipped.

If `False`, any access-denied error causes the ZIP operation to fail.

The default value is `True`.

### Zip.MaxDate

`Chilkat 11.7.0 · pascal · Zip · MaxDate · property · read/write · since 10.0.0`

```pascal
property MaxDate: string read GetMaxDate write SetMaxDate;
```

Maximum last-modified timestamp for files processed during add or extract operations.

Files having modification timestamps later than this value are skipped.

Supports ISO 8601 date/time formats, including:

- `YYYY-MM-DD`  
  Example: `2024-07-31`
- `YYYY-MM-DDTHH:MM:SS±HH:MM`  
  Example: `2024-07-31T12:34:56+02:00`
- `YYYY-MM-DDTHH:MM:SSZ`  
  Example: `2024-07-31T12:34:56Z`

The default value is the empty string, meaning no maximum date restriction.

### Zip.MaxUncompressSize

`Chilkat 11.7.0 · pascal · Zip · MaxUncompressSize · property · read/write · since 9.5.0.96`

```pascal
property MaxUncompressSize: LongWord read GetMaxUncompressSize write SetMaxUncompressSize;
```

Prevents extraction of files larger than the specified uncompressed size.

A value of `0` means no size limit.

The default value is `0`.

### Zip.MinDate

`Chilkat 11.7.0 · pascal · Zip · MinDate · property · read/write · since 10.0.0`

```pascal
property MinDate: string read GetMinDate write SetMinDate;
```

Minimum last-modified timestamp for files processed during add or extract operations.

Supports ISO 8601 date/time formats, including:

- `YYYY-MM-DD`  
  Example: `2024-07-31`
- `YYYY-MM-DDTHH:MM:SS±HH:MM`  
  Example: `2024-07-31T12:34:56+02:00`
- `YYYY-MM-DDTHH:MM:SSZ`  
  Example: `2024-07-31T12:34:56Z`

The default value is the empty string, meaning no minimum date restriction.

### Zip.NumEntries

`Chilkat 11.7.0 · pascal · Zip · NumEntries · property · read-only`

```pascal
property NumEntries: Integer read GetNumEntries;
```

Total number of entries in the ZIP, including both files and directories.

### Zip.OemCodePage

`Chilkat 11.7.0 · pascal · Zip · OemCodePage · property · read/write`

```pascal
property OemCodePage: Integer read GetOemCodePage write SetOemCodePage;
```

Specifies the OEM code page used for ZIP filename encoding.

Defaults to the OEM code page of the current computer.

### Zip.OverwriteExisting

`Chilkat 11.7.0 · pascal · Zip · OverwriteExisting · property · read/write`

```pascal
property OverwriteExisting: Boolean read GetOverwriteExisting write SetOverwriteExisting;
```

If `True`, existing files are overwritten during extraction.

The default value is `True`.

### Zip.PasswordProtect

`Chilkat 11.7.0 · pascal · Zip · PasswordProtect · property · read/write`

```pascal
property PasswordProtect: Boolean read GetPasswordProtect write SetPasswordProtect;
```

Indicates whether the ZIP uses legacy Zip 2.0 password protection.

This property is set automatically when a ZIP archive is opened by any of the `Open*` methods, such as `OpenZip`, `OpenFromMemory`, `OpenBd`, and related methods.

**Important:** `PasswordProtect` and `Encryption` are mutually exclusive.

If `PasswordProtect = True`, then `Encryption` should be `0`.

The default value is `False`.

### Zip.PathPrefix

`Chilkat 11.7.0 · pascal · Zip · PathPrefix · property · read/write`

```pascal
property PathPrefix: string read GetPathPrefix write SetPathPrefix;
```

Gets or sets a path prefix that is prepended to ZIP entry paths for files appended from the local filesystem.

This is useful when you want all extracted files to appear under a specific subdirectory.

This property affects only the following methods:

- `AppendFiles`
- `AppendFilesEx`
- `AddFile`
- `AppendOneFileOrDir`

The `PathPrefix` value is prepended to the stored ZIP path for each appended filesystem file.

For example, set PathPrefix to subdir/ so that files are stored in the ZIP with subdir/ prepended to their paths. When extracted, the files will be placed under the subdir directory.

This property does not affect entries added entirely from memory, such as entries added using:

- `AddString`
- `AddData`
- `AddBd`
- `AddSb`

For in-memory entries, the ZIP entry path is determined solely by the filename/path argument passed to the method.

The default value is the empty string.

### Zip.PercentDoneScale

`Chilkat 11.7.0 · pascal · Zip · PercentDoneScale · property · read/write · since 9.5.0.49`

```pascal
property PercentDoneScale: Integer read GetPercentDoneScale write SetPercentDoneScale;
```

Controls the granularity of PercentDone event callbacks.

This property is only applicable in programming environments that support event callbacks.

The value specifies what should be considered `100%` complete for progress reporting purposes.

- A value of `100` provides whole-percent progress updates.
- A value of `1000` provides tenth-percent granularity.
- For example, with a scale of `1000`, a PercentDone callback value of `453` represents `45.3%` complete.

Increasing this value allows for more frequent and finer-grained progress callbacks during long-running operations.

The value is automatically clamped to the range:

- Minimum: `10`
- Maximum: `100000`

The default value is `100`.

### Zip.PwdProtCharset

`Chilkat 11.7.0 · pascal · Zip · PwdProtCharset · property · read/write · since 9.5.0.73`

```pascal
property PwdProtCharset: string read GetPwdProtCharset write SetPwdProtCharset;
```

Specifies the character encoding used to convert the decrypt password into its binary byte representation for legacy password-protected ZIP archives that use Zip 2.0 encryption.

The default value is `ansi`.

Other possible values include:

- `cp850`
- `cp437`
- Any supported Windows or OEM code page listed at the link below.

This property applies only to older Zip 2.0 password protection and is not used for AES-encrypted ZIP archives.

### Zip.TempDir

`Chilkat 11.7.0 · pascal · Zip · TempDir · property · read/write`

```pascal
property TempDir: string read GetTempDir write SetTempDir;
```

Directory used for temporary files during ZIP operations.

When overwriting an existing ZIP file, a temporary file is used to avoid corrupting the original ZIP if an error occurs.

The default value depends on the runtime environment.

### Zip.UncommonOptions

`Chilkat 11.7.0 · pascal · Zip · UncommonOptions · property · read/write · since 9.5.0.84`

```pascal
property UncommonOptions: string read GetUncommonOptions write SetUncommonOptions;
```

Advanced options for uncommon scenarios.

- `ForceZip64` → Forces ZIP64 format even when not required.

The default value is the empty string.

### Zip.Zipx

`Chilkat 11.7.0 · pascal · Zip · Zipx · property · read/write`

```pascal
property Zipx: Boolean read GetZipx write SetZipx;
```

If `True`, creates ZIPX archives using the most appropriate compression method for each file.

The default value is `False`.

### Zip.ZipxDefaultAlg

`Chilkat 11.7.0 · pascal · Zip · ZipxDefaultAlg · property · read/write`

```pascal
property ZipxDefaultAlg: string read GetZipxDefaultAlg write SetZipxDefaultAlg;
```

Default compression algorithm used when creating ZIPX archives.

- Possible values include:
  - `deflate`
  - `ppmd`
  - `lzma`
  - `bzip2`
  - `deflate64`

The default value is `deflate`.

## Methods

### Zip.AddBd

`Chilkat 11.7.0 · pascal · Zip · AddBd · method · since 11.0.0`

```pascal
// bd is a TBinData object.

function  AddBd(const pathInZip: string;
    bd: TChilkatBase): Boolean;
```

Adds the contents of a `BinData` object as a new entry in the ZIP archive.

- `pathInZip` specifies the filename and optional directory path stored within the ZIP.
- The bytes contained in `bd` become the contents of the ZIP entry.
- The entry is added to the in-memory ZIP object and is not written to disk until `WriteZip`, `WriteZipAndClose`, `WriteBd`, or `WriteToMemory` is called.

Returns True for success, False for failure.

### Zip.AddEmpty

`Chilkat 11.7.0 · pascal · Zip · AddEmpty · method · since 11.0.0`

```pascal
function  AddEmpty(isDir: Boolean;
    const pathInZip: string): Boolean;
```

Adds an empty file or directory entry to the ZIP archive.

- If `isDir = True`, an empty directory entry is created.
- If `isDir = False`, an empty file entry is created.
- `pathInZip` specifies the path stored in the ZIP archive.

This method is useful when directory structure entries must exist even if no files are present.

Returns True for success, False for failure.

### Zip.AddEncoded

`Chilkat 11.7.0 · pascal · Zip · AddEncoded · method · since 11.0.0`

```pascal
function  AddEncoded(const pathInZip: string;
    const encoding: string;
    const data: string): Boolean;
```

Adds encoded binary data as a ZIP entry.

- `encoding` specifies how `data` is encoded.
- Common encodings include `base64` and `hex`.
- The decoded binary bytes become the contents of the ZIP entry.

This method is useful when binary data already exists in textual encoded form.

Returns True for success, False for failure.

### Zip.AddFile

`Chilkat 11.7.0 · pascal · Zip · AddFile · method · since 11.0.0`

```pascal
function  AddFile(const localPath: string;
    saveExtraPath: Boolean): Boolean;
```

Adds a file or directory from the local filesystem to the ZIP archive.

- If `localPath` is an absolute path and `saveExtraPath = True`, the stored ZIP path includes the relative directory structure.
- If `saveExtraPath = False`, only the filename is stored.
- If `localPath` is already relative, the relative path is stored as-is regardless of `saveExtraPath`.

This method adds a reference to the file or directory in the local filesystem. The file data is not immediately read or compressed.

The actual file contents are consumed only when a `Write*` method is called, such as:

- `WriteZip`
- `WriteZipAndClose`
- `WriteBd`
- `WriteToMemory`

This allows files and data entries to be accumulated in the in-memory ZIP object prior to writing the final ZIP archive.

Returns True for success, False for failure.

### Zip.AddNoCompressExtension

`Chilkat 11.7.0 · pascal · Zip · AddNoCompressExtension · method`

```pascal
procedure AddNoCompressExtension(const fileExtension: string);
```

Adds a file extension to the internal "no-compression" list.

Files having these extensions are stored without compression because they are already compressed or because compression would provide little benefit.

For example:

- `.zip`
- `.jpg`
- `.png`
- `.gz`

The extension may be specified with or without the leading dot.

Additional extensions remain active for the lifetime of the Zip object unless removed with `RemoveNoCompressExtension`.

### Zip.AddSb

`Chilkat 11.7.0 · pascal · Zip · AddSb · method · since 11.0.0`

```pascal
// sb is a TStringBuilder object.

function  AddSb(const pathInZip: string;
    sb: TChilkatBase;
    const charset: string): Boolean;
```

Adds the contents of a `StringBuilder` object as a text entry in the ZIP archive.

- The text is converted to bytes using the specified `charset`.
- `pathInZip` specifies the filename stored in the ZIP.

Returns True for success, False for failure.

### Zip.AddString

`Chilkat 11.7.0 · pascal · Zip · AddString · method · since 11.0.0`

```pascal
function  AddString(const pathInZip: string;
    const content: string;
    const charset: string): Boolean;
```

Adds a string as a text file entry in the ZIP archive.

- The string is converted to bytes using the specified `charset`.
- `pathInZip` specifies the path stored within the ZIP archive.

This method is useful for dynamically generating text files directly in memory.

Returns True for success, False for failure.

### Zip.AppendFiles

`Chilkat 11.7.0 · pascal · Zip · AppendFiles · method`

```pascal
function  AppendFiles(const filePattern: string;
    recurse: Boolean): Boolean;
```

Adds one or more files matching a wildcard pattern.

- The wildcard character `*` matches zero or more characters.
- If `recurse = True`, subdirectories are processed recursively.
- If `recurse = False`, only the current directory is searched.

For example:

> `AppendFiles("c:/temp/*.txt", False)`

This method only updates the in-memory ZIP object. The ZIP file itself is not written until a `Write*` method is called.

Returns True for success, False for failure.

### Zip.AppendFilesEx

`Chilkat 11.7.0 · pascal · Zip · AppendFilesEx · method`

```pascal
function  AppendFilesEx(const filePattern: string;
    recurse: Boolean;
    saveExtraPath: Boolean;
    archiveOnly: Boolean;
    includeHidden: Boolean;
    includeSystem: Boolean): Boolean;
```

Advanced version of `AppendFiles` with additional filtering and path options.

- `saveExtraPath` controls whether the extra leading path information from the `filePattern` is preserved in the ZIP.
- `archiveOnly` applies only on Windows and limits processing to files having the archive attribute set.
- `includeHidden` controls whether hidden files are included.
- `includeSystem` controls whether files with the System attribute are included.

This method adds references to files in the in-memory ZIP object. No ZIP file is written until a `Write*` method is called.

Returns True for success, False for failure.

### Zip.AppendZip

`Chilkat 11.7.0 · pascal · Zip · AppendZip · method`

```pascal
function  AppendZip(const zipPath: string): Boolean;
```

**Note:** This method is currently not working and will be fixed in v11.5.0

Adds all entries from another existing ZIP archive into the current ZIP object.

The `zipPath` argument specifies the path of a ZIP file located in the local filesystem.

All entries from the specified ZIP archive are appended to the current in-memory ZIP object.

The ZIP archive itself is not rewritten until a `Write*` method is called.

This method is useful for merging the contents of multiple ZIP archives into a single ZIP.

Returns True for success, False for failure.

### Zip.CloseZip

`Chilkat 11.7.0 · pascal · Zip · CloseZip · method`

```pascal
procedure CloseZip;
```

Closes the currently open ZIP archive and clears all entries from the Zip object.

This method has the same effect as calling `NewZip` without specifying a filename.

### Zip.DeleteEntry

`Chilkat 11.7.0 · pascal · Zip · DeleteEntry · method`

```pascal
// entry is a TZipEntry object.

function  DeleteEntry(entry: TChilkatBase): Boolean;
```

Removes a ZIP entry from the current ZIP object.

The ZIP file itself is not rewritten until a `Write*` method is called.

Returns True for success, False for failure.

### Zip.EntryAt

`Chilkat 11.7.0 · pascal · Zip · EntryAt · method · since 11.0.0`

```pascal
// entry is a TZipEntry object.

function  EntryAt(index: Integer;
    entry: TChilkatBase): Boolean;
```

Retrieves the ZIP entry at the specified zero-based index.

- The first entry is at index `0`.
- The matching entry is returned in the supplied `ZipEntry` object.

Returns True for success, False for failure.

### Zip.EntryById

`Chilkat 11.7.0 · pascal · Zip · EntryById · method · since 11.0.0`

```pascal
// entry is a TZipEntry object.

function  EntryById(id: Integer;
    entry: TChilkatBase): Boolean;
```

Finds a ZIP entry by its unique EntryID.

The matching entry is returned in the supplied `ZipEntry` object.

Returns True for success, False for failure.

### Zip.EntryMatching

`Chilkat 11.7.0 · pascal · Zip · EntryMatching · method · since 11.0.0`

```pascal
// entry is a TZipEntry object.

function  EntryMatching(const pattern: string;
    entry: TChilkatBase): Boolean;
```

Finds the first ZIP entry whose stored path matches a wildcard pattern.

- The wildcard character `*` matches zero or more characters.
- The comparison is performed against the full stored ZIP path.

Returns True for success, False for failure.

### Zip.EntryOf

`Chilkat 11.7.0 · pascal · Zip · EntryOf · method · since 11.0.0`

```pascal
// entry is a TZipEntry object.

function  EntryOf(const pathInZip: string;
    entry: TChilkatBase): Boolean;
```

Finds a ZIP entry whose stored path exactly matches `pathInZip`.

The matching entry is returned in the supplied `ZipEntry` object.

Returns True for success, False for failure.

### Zip.ExcludeDir

`Chilkat 11.7.0 · pascal · Zip · ExcludeDir · method`

```pascal
procedure ExcludeDir(const dirName: string);
```

Adds a directory name to the exclusion list used by recursive append operations.

- All directories having the specified name are skipped.
- The comparison is case-insensitive.
- Call multiple times to exclude multiple directory names.

This affects methods such as `AppendFiles` and `AppendFilesEx`.

### Zip.ExtractExe

`Chilkat 11.7.0 · pascal · Zip · ExtractExe · method · since 9.5.0.44`

```pascal
function  ExtractExe(const exePath: string;
    const dirPath: string): Boolean;
```

Extracts files from a Chilkat-created self-extracting EXE.

- Files are extracted into `dirPath`.
- Subdirectories are automatically created as needed.
- If the EXE is encrypted, `DecryptPassword` must be set before extraction.

Returns True for success, False for failure.

### Zip.GetDirectoryAsXML

`Chilkat 11.7.0 · pascal · Zip · GetDirectoryAsXML · method`

```pascal
function  GetDirectoryAsXML: string;
```

Returns the ZIP directory structure as an XML document.

The returned XML contains information about the entries currently contained within the ZIP archive, including files and directories.

This method is useful for inspecting ZIP contents without extracting files.

Returns the XML document as a string.

Returns True for success, False for failure.

### Zip.GetExeConfigParam

`Chilkat 11.7.0 · pascal · Zip · GetExeConfigParam · method`

```pascal
function  GetExeConfigParam(const name: string): string;
```

`(Windows only, for creating self-extracting EXE's)`

Returns the value of a configuration parameter embedded within a self-extracting EXE.

The `name` argument should be one of the XML tag names described in the `ExeXmlConfig` property documentation.

For example:

- `MainTitle`
- `MainCaption`
- `SetupExe`

Returns the parameter value as a string.

Returns True for success, False for failure.

### Zip.GetMaxUncompressedSize

`Chilkat 11.7.0 · pascal · Zip · GetMaxUncompressedSize · method · since 9.5.0.96`

```pascal
function  GetMaxUncompressedSize: string;
```

Returns the largest uncompressed file size contained within the ZIP archive.

The size is returned as a string rather than an integer because the value may exceed the range of a 32-bit integer.

This method is useful when:

- Checking for extremely large files before extraction
- Estimating required disk space
- Detecting unusually large compressed entries

Returns the size as a decimal string.

Returns True for success, False for failure.

### Zip.IsNoCompressExtension

`Chilkat 11.7.0 · pascal · Zip · IsNoCompressExtension · method`

```pascal
function  IsNoCompressExtension(const fileExtension: string): Boolean;
```

Checks whether a file extension is contained in the internal "no-compression" extension list.

Files having extensions in this list are stored without compression because they are typically already compressed.

The extension may be specified with or without the leading dot.

For example, both of the following are valid:

- `.jpg`
- `jpg`

Returns `True` if the extension exists in the list, otherwise returns `False`.

### Zip.IsPasswordProtected

`Chilkat 11.7.0 · pascal · Zip · IsPasswordProtected · method`

```pascal
function  IsPasswordProtected(const zipPath: string): Boolean;
```

Checks whether a ZIP archive uses legacy Zip 2.0 password protection.

The `zipPath` argument specifies the path of a ZIP file in the local filesystem.

This method checks only for traditional Zip 2.0 password protection.

Returns `True` if the ZIP archive is password protected, otherwise returns `False`.

### Zip.LoadTaskCaller

`Chilkat 11.7.0 · pascal · Zip · 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.

### Zip.NewZip

`Chilkat 11.7.0 · pascal · Zip · NewZip · method`

```pascal
function  NewZip(const zipPath: string): Boolean;
```

Initializes a new empty ZIP archive.

- If another ZIP archive is currently open, it is closed.
- All existing in-memory ZIP entries are discarded.
- The `FileName` property is set to `zipPath`.

No ZIP file is actually created until a `Write*` method is called.

This method resets the Zip object to a clean empty state.

Returns True for success, False for failure.

### Zip.OpenBd

`Chilkat 11.7.0 · pascal · Zip · OpenBd · method · since 9.5.0.66`

```pascal
// binData is a TBinData object.

function  OpenBd(binData: TChilkatBase): Boolean;
```

Opens a ZIP archive contained entirely within a `BinData` object.

This method allows ZIP archives to be processed entirely in memory without requiring a filesystem file.

When a ZIP archive is opened:

- `PasswordProtect` is automatically set if legacy Zip 2.0 encryption is detected.
- `Encryption` is automatically set if strong encryption is detected.
- A value of `4` for `Encryption` indicates WinZip-compatible AES encryption.

Returns True for success, False for failure.

### Zip.OpenEmbedded

`Chilkat 11.7.0 · pascal · Zip · OpenEmbedded · method`

```pascal
function  OpenEmbedded(const exeFilename: string;
    const resourceName: string): Boolean;
```

`(Windows only)`

Opens a ZIP archive embedded as a resource within a Windows executable.

- `exeFilename` specifies the EXE file path.
- `resourceName` specifies the embedded resource name containing the ZIP data.

This method is useful when ZIP archives are packaged within Windows applications.

Returns True for success, False for failure.

### Zip.OpenZip

`Chilkat 11.7.0 · pascal · Zip · OpenZip · method`

```pascal
function  OpenZip(const zipPath: string): Boolean;
```

Opens a ZIP archive from the local filesystem.

The `zipPath` argument specifies the path of the ZIP file to open.

Encrypted ZIP archives may be opened without providing a password, but encrypted entries cannot be extracted until the correct password is provided using `DecryptPassword`.

When the ZIP archive is opened:

- `PasswordProtect` is automatically set if legacy Zip 2.0 encryption is detected.
- `Encryption` is automatically set if strong encryption is detected.
- `Encryption = 4` indicates WinZip-compatible AES encryption.

Returns True for success, False for failure.

### Zip.QuickAppend

`Chilkat 11.7.0 · pascal · Zip · QuickAppend · method`

```pascal
function  QuickAppend(const zipPath: string): Boolean;
```

Efficiently appends additional entries to an existing ZIP archive.

The `zipPath` argument specifies the path of an existing ZIP archive in the local filesystem.

This method avoids rewriting existing entries.

- Existing ZIP entries remain unchanged.
- New entries are appended to the end of the ZIP archive.
- The ZIP central directory is updated accordingly.

This method is typically faster than rebuilding the entire ZIP archive.

Returns True for success, False for failure.

### Zip.RemoveNoCompressExtension

`Chilkat 11.7.0 · pascal · Zip · RemoveNoCompressExtension · method`

```pascal
procedure RemoveNoCompressExtension(const fileExtension: string);
```

Removes a file extension from the internal "no-compression" extension list.

After removal, files having this extension may be compressed normally.

The extension may be specified with or without the leading dot.

### Zip.SetCompressionLevel

`Chilkat 11.7.0 · pascal · Zip · SetCompressionLevel · method`

```pascal
procedure SetCompressionLevel(level: Integer);
```

Sets the compression level for all file and data entries currently contained within the ZIP object.

- `0` → No compression
- `9` → Maximum compression

The default compression level is `6`.

**Important:** This method should be called after files or data entries have already been added to the ZIP object.

The compression level cannot be changed for mapped entries originating from an already-open ZIP archive.

### Zip.SetExclusions

`Chilkat 11.7.0 · pascal · Zip · SetExclusions · method`

```pascal
// excludePatterns is a TStringArray object.

procedure SetExclusions(excludePatterns: TChilkatBase);
```

Specifies a collection of wildcard exclusion patterns used when adding files to the ZIP archive.

Each pattern may use the wildcard character `*` to match zero or more characters.

Files matching any exclusion pattern are skipped.

### Zip.SetExeConfigParam

`Chilkat 11.7.0 · pascal · Zip · SetExeConfigParam · method`

```pascal
procedure SetExeConfigParam(const paramName: string;
    const paramValue: string);
```

`(Windows only, for creating self-extracting EXE's)`

Sets a configuration parameter embedded within a self-extracting EXE created by `WriteExe` or `WriteExe2`.

The `paramName` should be one of the XML configuration tag names described in the `ExeXmlConfig` property documentation.

For example:

> `SetExeConfigParam("MainUnzipBtn","Extract")`

This changes the text displayed on the self-extractor's main unzip button.

### Zip.Unzip

`Chilkat 11.7.0 · pascal · Zip · Unzip · method`

```pascal
function  Unzip(const dirPath: string): Integer;
```

Extracts all files and directories from the ZIP archive.

- `dirPath` specifies the destination directory.
- Subdirectories are automatically created as needed.

Returns the number of files extracted.

Returns `-1` if a failure occurs.

### Zip.UnzipInto

`Chilkat 11.7.0 · pascal · Zip · UnzipInto · method`

```pascal
function  UnzipInto(const dirPath: string): Integer;
```

Extracts all files into a single directory.

All directory path information stored within the ZIP archive is ignored.

If multiple files have the same filename, later extracted files overwrite earlier ones.

Returns the number of files extracted, or `-1` on failure.

### Zip.UnzipMatching

`Chilkat 11.7.0 · pascal · Zip · UnzipMatching · method`

```pascal
function  UnzipMatching(const dirPath: string;
    const pattern: string;
    verbose: Boolean): Integer;
```

Extracts only entries whose stored paths match a wildcard pattern.

- The wildcard character `*` matches zero or more characters.
- If no wildcard is used, an exact filename match is required.

Subdirectories are automatically created as needed.

Returns the number of files extracted, or `-1` on failure.

### Zip.UnzipMatchingInto

`Chilkat 11.7.0 · pascal · Zip · UnzipMatchingInto · method`

```pascal
function  UnzipMatchingInto(const dirPath: string;
    const pattern: string;
    verbose: Boolean): Integer;
```

Extracts matching entries into a single directory while ignoring all stored ZIP path information.

Matching behavior is identical to `UnzipMatching`.

If duplicate filenames occur, later extracted files overwrite earlier ones.

Returns the number of files extracted, or `-1` on failure.

### Zip.UnzipNewer

`Chilkat 11.7.0 · pascal · Zip · UnzipNewer · method`

```pascal
function  UnzipNewer(const dirPath: string): Integer;
```

Extracts only files that:

- Do not already exist
- Or have older modification timestamps than the ZIP entry

Subdirectories are automatically created as needed.

Returns the number of files extracted, or `-1` on failure.

### Zip.VerifyPassword

`Chilkat 11.7.0 · pascal · Zip · VerifyPassword · method`

```pascal
function  VerifyPassword: Boolean;
```

Verifies that the current `DecryptPassword` value is correct for the currently opened ZIP archive.

This method allows password validation before attempting extraction.

Returns `True` if the password is valid, otherwise returns `False`.

### Zip.WriteBd

`Chilkat 11.7.0 · pascal · Zip · WriteBd · method · since 9.5.0.66`

```pascal
// binData is a TBinData object.

function  WriteBd(binData: TChilkatBase): Boolean;
```

Writes the ZIP archive to a `BinData` object instead of a filesystem file.

The generated ZIP archive exists entirely in memory.

The ZIP data written by this method may later be opened using `OpenBd`.

Returns True for success, False for failure.

### Zip.WriteExe

`Chilkat 11.7.0 · pascal · Zip · WriteExe · method`

```pascal
function  WriteExe(const exeFilename: string): Boolean;
```

`(Windows only, for creating self-extracting EXE's)`

Creates a Windows self-extracting executable (EXE).

The generated EXE contains both the extraction logic and the ZIP archive data.

There are no limitations on:

- Total ZIP size
- Individual file size
- Number of files

The generated EXE supports the following command-line arguments:

- `-log logFileName`
- `-unzipDir unzipDirectoryPath`
- `-pwd password`
- `-ap autoRunParams`

Returns True for success, False for failure.

See also:

- [More information about self-extracting executables.](http://www.cknotes.com/?p=351)

### Zip.WriteZip

`Chilkat 11.7.0 · pascal · Zip · WriteZip · method`

```pascal
function  WriteZip: Boolean;
```

Saves the Zip to a file and implictly re-opens it so further operations can continue. Use WriteZipAndClose to write and close the Zip. There is no limitation on the size of files that may be contained within a .zip, the total number of files in a .zip, or the total size of a .zip. If necessary, WriteZip will use the ZIP64 file format extensions when 4GB or file count limitations of the old zip file format are exceeded.

Returns True for success, False for failure.

### Zip.WriteZipAndClose

`Chilkat 11.7.0 · pascal · Zip · WriteZipAndClose · method`

```pascal
function  WriteZipAndClose: Boolean;
```

Saves the Zip to a file and closes it. On return, the Zip object will be in the state as if NewZip had been called. There is no limitation on the size of files that may be contained within a .zip, the total number of files in a .zip, or the total size of a .zip. If necessary, WriteZip will use the ZIP64 file format extensions when 4GB or file count limitations of the old zip file format are exceeded.

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.

### Zip.AbortCheck (event)

`Chilkat 11.7.0 · pascal · Zip · 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.ZipAbortCheck(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
zip := TZip.Create;
zip.HeartbeatMs := 250;   // fire OnAbortCheck 4 times per second
zip.OnAbortCheck := MyObject.ZipAbortCheck;
```

### Zip.PercentDone (event)

`Chilkat 11.7.0 · pascal · Zip · 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.ZipPercentDone(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
zip := TZip.Create;
zip.OnPercentDone := MyObject.ZipPercentDone;
```

### Zip.ProgressInfo (event)

`Chilkat 11.7.0 · pascal · Zip · 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.ZipProgressInfo(Sender: TChilkatBase; const Name, Value: string);
begin
  WriteLn(Name, ': ', Value);
end;
```

**To add an event handler:**

```pascal
zip := TZip.Create;
zip.OnProgressInfo := MyObject.ZipProgressInfo;
```

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/BinData.md), [`StringArray`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/StringArray.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/StringBuilder.md), [`ZipEntry`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/pascal/classes/ZipEntry.md)