---
product: Chilkat
product_version: 11.7.0
language: tcl
language_label: Tcl
class: Zip
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/tclZipRef.html
---
# Chilkat Zip — Tcl — v11.7.0

> Chilkat 11.7.0 · language=tcl · 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/tcl/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

**Object Creation**

```tcl
# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkZip]
```

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 Tcl.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## 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` | `string # ckStr is a CkString CkZip_get_DebugLogFilePath $this $ckStr set strVal [CkZip_get_debugLogFilePath $this] CkZip_put_DebugLogFilePath $this $strVal` | 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` | `string # ckStr is a CkString CkZip_get_LastErrorHtml $this $ckStr set strVal [CkZip_get_lastErrorHtml $this]` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string # ckStr is a CkString CkZip_get_LastErrorText $this $ckStr set strVal [CkZip_get_lastErrorText $this]` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string # ckStr is a CkString CkZip_get_LastErrorXml $this $ckStr set strVal [CkZip_get_lastErrorXml $this]` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean 1/0 set boolVal [CkZip_get_LastMethodSuccess $this] CkZip_put_LastMethodSuccess $this $boolVal` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `boolean 1/0 set boolVal [CkZip_get_Utf8 $this] CkZip_put_Utf8 $this $boolVal` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `boolean 1/0 set boolVal [CkZip_get_VerboseLogging $this] CkZip_put_VerboseLogging $this $boolVal` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string # ckStr is a CkString CkZip_get_Version $this $ckStr set strVal [CkZip_get_version $this]` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_AbortCurrent $this] CkZip_put_AbortCurrent $this $boolVal` |
| `AppendFromDir` | property, read/write | `string # ckStr is a CkString CkZip_get_AppendFromDir $this $ckStr set strVal [CkZip_get_appendFromDir $this] CkZip_put_AppendFromDir $this $strVal` |
| `AutoRun` | property, read/write | `string # ckStr is a CkString CkZip_get_AutoRun $this $ckStr set strVal [CkZip_get_autoRun $this] CkZip_put_AutoRun $this $strVal` |
| `AutoRunParams` | property, read/write | `string # ckStr is a CkString CkZip_get_AutoRunParams $this $ckStr set strVal [CkZip_get_autoRunParams $this] CkZip_put_AutoRunParams $this $strVal` |
| `AutoTemp` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_AutoTemp $this] CkZip_put_AutoTemp $this $boolVal` |
| `CaseSensitive` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_CaseSensitive $this] CkZip_put_CaseSensitive $this $boolVal` |
| `ClearArchiveAttribute` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_ClearArchiveAttribute $this] CkZip_put_ClearArchiveAttribute $this $boolVal` |
| `ClearReadOnlyAttr` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_ClearReadOnlyAttr $this] CkZip_put_ClearReadOnlyAttr $this $boolVal` |
| `Comment` | property, read/write | `string # ckStr is a CkString CkZip_get_Comment $this $ckStr set strVal [CkZip_get_comment $this] CkZip_put_Comment $this $strVal` |
| `DecryptPassword` | property, read/write | `string # ckStr is a CkString CkZip_get_DecryptPassword $this $ckStr set strVal [CkZip_get_decryptPassword $this] CkZip_put_DecryptPassword $this $strVal` |
| `DiscardPaths` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_DiscardPaths $this] CkZip_put_DiscardPaths $this $boolVal` |
| `Encryption` | property, read/write | `integer set intVal [CkZip_get_Encryption $this] CkZip_put_Encryption $this $intVal` |
| `EncryptKeyLength` | property, read/write | `integer set intVal [CkZip_get_EncryptKeyLength $this] CkZip_put_EncryptKeyLength $this $intVal` |
| `EncryptPassword` | property, read/write | `string # ckStr is a CkString CkZip_get_EncryptPassword $this $ckStr set strVal [CkZip_get_encryptPassword $this] CkZip_put_EncryptPassword $this $strVal` |
| `ExeDefaultDir` | property, read/write | `string # ckStr is a CkString CkZip_get_ExeDefaultDir $this $ckStr set strVal [CkZip_get_exeDefaultDir $this] CkZip_put_ExeDefaultDir $this $strVal` |
| `ExeFinishNotifier` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_ExeFinishNotifier $this] CkZip_put_ExeFinishNotifier $this $boolVal` |
| `ExeIconFile` | property, read/write | `string # ckStr is a CkString CkZip_get_ExeIconFile $this $ckStr set strVal [CkZip_get_exeIconFile $this] CkZip_put_ExeIconFile $this $strVal` |
| `ExeNoInterface` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_ExeNoInterface $this] CkZip_put_ExeNoInterface $this $boolVal` |
| `ExeSilentProgress` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_ExeSilentProgress $this] CkZip_put_ExeSilentProgress $this $boolVal` |
| `ExeTitle` | property, read/write | `string # ckStr is a CkString CkZip_get_ExeTitle $this $ckStr set strVal [CkZip_get_exeTitle $this] CkZip_put_ExeTitle $this $strVal` |
| `ExeUnzipCaption` | property, read/write | `string # ckStr is a CkString CkZip_get_ExeUnzipCaption $this $ckStr set strVal [CkZip_get_exeUnzipCaption $this] CkZip_put_ExeUnzipCaption $this $strVal` |
| `ExeUnzipDir` | property, read/write | `string # ckStr is a CkString CkZip_get_ExeUnzipDir $this $ckStr set strVal [CkZip_get_exeUnzipDir $this] CkZip_put_ExeUnzipDir $this $strVal` |
| `ExeWaitForSetup` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_ExeWaitForSetup $this] CkZip_put_ExeWaitForSetup $this $boolVal` |
| `ExeXmlConfig` | property, read/write | `string # ckStr is a CkString CkZip_get_ExeXmlConfig $this $ckStr set strVal [CkZip_get_exeXmlConfig $this] CkZip_put_ExeXmlConfig $this $strVal` |
| `FileCount` | property, read-only | `integer set intVal [CkZip_get_FileCount $this]` |
| `FileName` | property, read/write | `string # ckStr is a CkString CkZip_get_FileName $this $ckStr set strVal [CkZip_get_fileName $this] CkZip_put_FileName $this $strVal` |
| `HasZipFormatErrors` | property, read-only | `boolean 1/0 set boolVal [CkZip_get_HasZipFormatErrors $this]` |
| `IgnoreAccessDenied` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_IgnoreAccessDenied $this] CkZip_put_IgnoreAccessDenied $this $boolVal` |
| `MaxDate` | property, read/write | `string # ckStr is a CkString CkZip_get_MaxDate $this $ckStr set strVal [CkZip_get_maxDate $this] CkZip_put_MaxDate $this $strVal` |
| `MaxUncompressSize` | property, read/write | `unsigned integer set intVal [CkZip_get_MaxUncompressSize $this] CkZip_put_MaxUncompressSize $this $intVal` |
| `MinDate` | property, read/write | `string # ckStr is a CkString CkZip_get_MinDate $this $ckStr set strVal [CkZip_get_minDate $this] CkZip_put_MinDate $this $strVal` |
| `NumEntries` | property, read-only | `integer set intVal [CkZip_get_NumEntries $this]` |
| `OemCodePage` | property, read/write | `integer set intVal [CkZip_get_OemCodePage $this] CkZip_put_OemCodePage $this $intVal` |
| `OverwriteExisting` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_OverwriteExisting $this] CkZip_put_OverwriteExisting $this $boolVal` |
| `PasswordProtect` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_PasswordProtect $this] CkZip_put_PasswordProtect $this $boolVal` |
| `PathPrefix` | property, read/write | `string # ckStr is a CkString CkZip_get_PathPrefix $this $ckStr set strVal [CkZip_get_pathPrefix $this] CkZip_put_PathPrefix $this $strVal` |
| `PwdProtCharset` | property, read/write | `string # ckStr is a CkString CkZip_get_PwdProtCharset $this $ckStr set strVal [CkZip_get_pwdProtCharset $this] CkZip_put_PwdProtCharset $this $strVal` |
| `TempDir` | property, read/write | `string # ckStr is a CkString CkZip_get_TempDir $this $ckStr set strVal [CkZip_get_tempDir $this] CkZip_put_TempDir $this $strVal` |
| `UncommonOptions` | property, read/write | `string # ckStr is a CkString CkZip_get_UncommonOptions $this $ckStr set strVal [CkZip_get_uncommonOptions $this] CkZip_put_UncommonOptions $this $strVal` |
| `Zipx` | property, read/write | `boolean 1/0 set boolVal [CkZip_get_Zipx $this] CkZip_put_Zipx $this $boolVal` |
| `ZipxDefaultAlg` | property, read/write | `string # ckStr is a CkString CkZip_get_ZipxDefaultAlg $this $ckStr set strVal [CkZip_get_zipxDefaultAlg $this] CkZip_put_ZipxDefaultAlg $this $strVal` |
| `AddBd` | method | `# pathInZip is a string # bd is a CkBinData set status [CkZip_AddBd $this $pathInZip $bd]` |
| `AddEmpty` | method | `# isDir is a boolean # pathInZip is a string set status [CkZip_AddEmpty $this $isDir $pathInZip]` |
| `AddEncoded` | method | `# pathInZip is a string # encoding is a string # data is a string set status [CkZip_AddEncoded $this $pathInZip $encoding $data]` |
| `AddFile` | method | `# localPath is a string # saveExtraPath is a boolean set status [CkZip_AddFile $this $localPath $saveExtraPath]` |
| `AddNoCompressExtension` | method | `# fileExtension is a string CkZip_AddNoCompressExtension $this $fileExtension` |
| `AddSb` | method | `# pathInZip is a string # sb is a CkStringBuilder # charset is a string set status [CkZip_AddSb $this $pathInZip $sb $charset]` |
| `AddString` | method | `# pathInZip is a string # content is a string # charset is a string set status [CkZip_AddString $this $pathInZip $content $charset]` |
| `AppendFiles` | method | `# filePattern is a string # recurse is a boolean set status [CkZip_AppendFiles $this $filePattern $recurse]` |
| `AppendFilesEx` | method | `# filePattern is a string # recurse is a boolean # saveExtraPath is a boolean # archiveOnly is a boolean # includeHidden is a boolean # includeSystem is a boolean set status [CkZip_AppendFilesEx $this $filePattern $recurse $saveExtraPath $archiveOnly $includeHidden $includeSystem]` |
| `AppendZip` | method | `# zipPath is a string set status [CkZip_AppendZip $this $zipPath]` |
| `CloseZip` | method | `CkZip_CloseZip $this` |
| `DeleteEntry` | method | `# entry is a CkZipEntry set status [CkZip_DeleteEntry $this $entry]` |
| `EntryAt` | method | `# index is an integer # entry is a CkZipEntry set status [CkZip_EntryAt $this $index $entry]` |
| `EntryById` | method | `# id is an integer # entry is a CkZipEntry set status [CkZip_EntryById $this $id $entry]` |
| `EntryMatching` | method | `# pattern is a string # entry is a CkZipEntry set status [CkZip_EntryMatching $this $pattern $entry]` |
| `EntryOf` | method | `# pathInZip is a string # entry is a CkZipEntry set status [CkZip_EntryOf $this $pathInZip $entry]` |
| `ExcludeDir` | method | `# dirName is a string CkZip_ExcludeDir $this $dirName` |
| `ExtractExe` | method | `# exePath is a string # dirPath is a string set status [CkZip_ExtractExe $this $exePath $dirPath]` |
| `GetDirectoryAsXML` | method | `# outXml is a CkString (output) set status [CkZip_GetDirectoryAsXML $this $outStr] set retStr [CkZip_getDirectoryAsXML $this]` |
| `GetExeConfigParam` | method | `# name is a string # outStr is a CkString (output) set status [CkZip_GetExeConfigParam $this $name $outStr] set retStr [CkZip_getExeConfigParam $this $name]` |
| `GetMaxUncompressedSize` | method | `# outStr is a CkString (output) set status [CkZip_GetMaxUncompressedSize $this $outStr] set retStr [CkZip_getMaxUncompressedSize $this]` |
| `IsNoCompressExtension` | method | `# fileExtension is a string set retBool [CkZip_IsNoCompressExtension $this $fileExtension]` |
| `IsPasswordProtected` | method | `# zipPath is a string set retBool [CkZip_IsPasswordProtected $this $zipPath]` |
| `LoadTaskCaller` | method | `# task is a CkTask set status [CkZip_LoadTaskCaller $this $task]` |
| `NewZip` | method | `# zipPath is a string set status [CkZip_NewZip $this $zipPath]` |
| `OpenBd` | method | `# binData is a CkBinData set status [CkZip_OpenBd $this $binData]` |
| `OpenEmbedded` | method | `# exeFilename is a string # resourceName is a string set status [CkZip_OpenEmbedded $this $exeFilename $resourceName]` |
| `OpenZip` | method | `# zipPath is a string set status [CkZip_OpenZip $this $zipPath]` |
| `QuickAppend` | method | `# zipPath is a string set status [CkZip_QuickAppend $this $zipPath]` |
| `RemoveNoCompressExtension` | method | `# fileExtension is a string CkZip_RemoveNoCompressExtension $this $fileExtension` |
| `SetCompressionLevel` | method | `# level is an integer CkZip_SetCompressionLevel $this $level` |
| `SetExclusions` | method | `# excludePatterns is a CkStringArray CkZip_SetExclusions $this $excludePatterns` |
| `SetExeConfigParam` | method | `# paramName is a string # paramValue is a string CkZip_SetExeConfigParam $this $paramName $paramValue` |
| `Unzip` | method | `# dirPath is a string set retInt [CkZip_Unzip $this $dirPath]` |
| `UnzipInto` | method | `# dirPath is a string set retInt [CkZip_UnzipInto $this $dirPath]` |
| `UnzipMatching` | method | `# dirPath is a string # pattern is a string # verbose is a boolean set retInt [CkZip_UnzipMatching $this $dirPath $pattern $verbose]` |
| `UnzipMatchingInto` | method | `# dirPath is a string # pattern is a string # verbose is a boolean set retInt [CkZip_UnzipMatchingInto $this $dirPath $pattern $verbose]` |
| `UnzipNewer` | method | `# dirPath is a string set retInt [CkZip_UnzipNewer $this $dirPath]` |
| `VerifyPassword` | method | `set retBool [CkZip_VerifyPassword $this]` |
| `WriteBd` | method | `# binData is a CkBinData set status [CkZip_WriteBd $this $binData]` |
| `WriteExe` | method | `# exeFilename is a string set status [CkZip_WriteExe $this $exeFilename]` |
| `WriteZip` | method | `set status [CkZip_WriteZip $this]` |
| `WriteZipAndClose` | method | `set status [CkZip_WriteZipAndClose $this]` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Properties

### Zip.AbortCurrent

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

```tcl
boolean 1/0
set boolVal [CkZip_get_AbortCurrent $this]

CkZip_put_AbortCurrent $this $boolVal
```

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

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

### Zip.AppendFromDir

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

```tcl
string
# ckStr is a CkString

CkZip_get_AppendFromDir $this $ckStr

set strVal [CkZip_get_appendFromDir $this]

CkZip_put_AppendFromDir $this $strVal
```

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 · tcl · Zip · AutoRun · property · read/write`

```tcl
string
# ckStr is a CkString

CkZip_get_AutoRun $this $ckStr

set strVal [CkZip_get_autoRun $this]

CkZip_put_AutoRun $this $strVal
```

`(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 · tcl · Zip · AutoRunParams · property · read/write`

```tcl
string
# ckStr is a CkString

CkZip_get_AutoRunParams $this $ckStr

set strVal [CkZip_get_autoRunParams $this]

CkZip_put_AutoRunParams $this $strVal
```

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

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

### Zip.AutoTemp

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

```tcl
boolean 1/0
set boolVal [CkZip_get_AutoTemp $this]

CkZip_put_AutoTemp $this $boolVal
```

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

If `1`, 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 = 0`  
> `ExeNoInterface = 1`  
> `ExeFinishNotifier = 0`

The default value is `0`.

### Zip.CaseSensitive

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

```tcl
boolean 1/0
set boolVal [CkZip_get_CaseSensitive $this]

CkZip_put_CaseSensitive $this $boolVal
```

Controls whether filename matching is case-sensitive.

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

### Zip.ClearArchiveAttribute

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

```tcl
boolean 1/0
set boolVal [CkZip_get_ClearArchiveAttribute $this]

CkZip_put_ClearArchiveAttribute $this $boolVal
```

`(Windows only)`

If `1`, 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 `0`.

### Zip.ClearReadOnlyAttr

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

```tcl
boolean 1/0
set boolVal [CkZip_get_ClearReadOnlyAttr $this]

CkZip_put_ClearReadOnlyAttr $this $boolVal
```

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

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

The default value is `0`.

### Zip.Comment

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

```tcl
string
# ckStr is a CkString

CkZip_get_Comment $this $ckStr

set strVal [CkZip_get_comment $this]

CkZip_put_Comment $this $strVal
```

Sets or retrieves the global ZIP file comment.

The default value is the empty string.

### Zip.DecryptPassword

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

```tcl
string
# ckStr is a CkString

CkZip_get_DecryptPassword $this $ckStr

set strVal [CkZip_get_decryptPassword $this]

CkZip_put_DecryptPassword $this $strVal
```

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 · tcl · Zip · DiscardPaths · property · read/write`

```tcl
boolean 1/0
set boolVal [CkZip_get_DiscardPaths $this]

CkZip_put_DiscardPaths $this $boolVal
```

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

Only filenames are stored in the ZIP.

The default value is `0`.

### Zip.Encryption

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

```tcl
integer
set intVal [CkZip_get_Encryption $this]

CkZip_put_Encryption $this $intVal
```

Specifies encryption mode:

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

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

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

The default value is `0`.

### Zip.EncryptKeyLength

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

```tcl
integer
set intVal [CkZip_get_EncryptKeyLength $this]

CkZip_put_EncryptKeyLength $this $intVal
```

Specifies the AES encryption key length.

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

The default value is `128`.

### Zip.EncryptPassword

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

```tcl
string
# ckStr is a CkString

CkZip_get_EncryptPassword $this $ckStr

set strVal [CkZip_get_encryptPassword $this]

CkZip_put_EncryptPassword $this $strVal
```

Password used when creating encrypted ZIP archives.

The default value is the empty string.

### Zip.ExeDefaultDir

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

```tcl
string
# ckStr is a CkString

CkZip_get_ExeDefaultDir $this $ckStr

set strVal [CkZip_get_exeDefaultDir $this]

CkZip_put_ExeDefaultDir $this $strVal
```

`(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 · tcl · Zip · ExeFinishNotifier · property · read/write`

```tcl
boolean 1/0
set boolVal [CkZip_get_ExeFinishNotifier $this]

CkZip_put_ExeFinishNotifier $this $boolVal
```

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

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

The default value is `0`.

### Zip.ExeIconFile

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

```tcl
string
# ckStr is a CkString

CkZip_get_ExeIconFile $this $ckStr

set strVal [CkZip_get_exeIconFile $this]

CkZip_put_ExeIconFile $this $strVal
```

`(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 · tcl · Zip · ExeNoInterface · property · read/write`

```tcl
boolean 1/0
set boolVal [CkZip_get_ExeNoInterface $this]

CkZip_put_ExeNoInterface $this $boolVal
```

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

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

The default value is `0`.

### Zip.ExeSilentProgress

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

```tcl
boolean 1/0
set boolVal [CkZip_get_ExeSilentProgress $this]

CkZip_put_ExeSilentProgress $this $boolVal
```

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

Controls whether a progress dialog is shown during extraction.

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

The default value is `0`.

### Zip.ExeTitle

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

```tcl
string
# ckStr is a CkString

CkZip_get_ExeTitle $this $ckStr

set strVal [CkZip_get_exeTitle $this]

CkZip_put_ExeTitle $this $strVal
```

`(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 · tcl · Zip · ExeUnzipCaption · property · read/write`

```tcl
string
# ckStr is a CkString

CkZip_get_ExeUnzipCaption $this $ckStr

set strVal [CkZip_get_exeUnzipCaption $this]

CkZip_put_ExeUnzipCaption $this $strVal
```

`(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 · tcl · Zip · ExeUnzipDir · property · read/write`

```tcl
string
# ckStr is a CkString

CkZip_get_ExeUnzipDir $this $ckStr

set strVal [CkZip_get_exeUnzipDir $this]

CkZip_put_ExeUnzipDir $this $strVal
```

`(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 · tcl · Zip · ExeWaitForSetup · property · read/write`

```tcl
boolean 1/0
set boolVal [CkZip_get_ExeWaitForSetup $this]

CkZip_put_ExeWaitForSetup $this $boolVal
```

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

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

The default value is `1`.

### Zip.ExeXmlConfig

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

```tcl
string
# ckStr is a CkString

CkZip_get_ExeXmlConfig $this $ckStr

set strVal [CkZip_get_exeXmlConfig $this]

CkZip_put_ExeXmlConfig $this $strVal
```

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 · tcl · Zip · FileCount · property · read-only`

```tcl
integer
set intVal [CkZip_get_FileCount $this]
```

Number of files in the ZIP, excluding directory entries.

### Zip.FileName

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

```tcl
string
# ckStr is a CkString

CkZip_get_FileName $this $ckStr

set strVal [CkZip_get_fileName $this]

CkZip_put_FileName $this $strVal
```

Path of the ZIP file to be written or overwritten.

The default value is the empty string.

### Zip.HasZipFormatErrors

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

```tcl
boolean 1/0
set boolVal [CkZip_get_HasZipFormatErrors $this]
```

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

### Zip.IgnoreAccessDenied

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

```tcl
boolean 1/0
set boolVal [CkZip_get_IgnoreAccessDenied $this]

CkZip_put_IgnoreAccessDenied $this $boolVal
```

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

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

The default value is `1`.

### Zip.MaxDate

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

```tcl
string
# ckStr is a CkString

CkZip_get_MaxDate $this $ckStr

set strVal [CkZip_get_maxDate $this]

CkZip_put_MaxDate $this $strVal
```

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 · tcl · Zip · MaxUncompressSize · property · read/write · since 9.5.0.96`

```tcl
unsigned integer
set intVal [CkZip_get_MaxUncompressSize $this]

CkZip_put_MaxUncompressSize $this $intVal
```

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 · tcl · Zip · MinDate · property · read/write · since 10.0.0`

```tcl
string
# ckStr is a CkString

CkZip_get_MinDate $this $ckStr

set strVal [CkZip_get_minDate $this]

CkZip_put_MinDate $this $strVal
```

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 · tcl · Zip · NumEntries · property · read-only`

```tcl
integer
set intVal [CkZip_get_NumEntries $this]
```

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

### Zip.OemCodePage

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

```tcl
integer
set intVal [CkZip_get_OemCodePage $this]

CkZip_put_OemCodePage $this $intVal
```

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 · tcl · Zip · OverwriteExisting · property · read/write`

```tcl
boolean 1/0
set boolVal [CkZip_get_OverwriteExisting $this]

CkZip_put_OverwriteExisting $this $boolVal
```

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

The default value is `1`.

### Zip.PasswordProtect

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

```tcl
boolean 1/0
set boolVal [CkZip_get_PasswordProtect $this]

CkZip_put_PasswordProtect $this $boolVal
```

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 = 1`, then `Encryption` should be `0`.

The default value is `0`.

### Zip.PathPrefix

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

```tcl
string
# ckStr is a CkString

CkZip_get_PathPrefix $this $ckStr

set strVal [CkZip_get_pathPrefix $this]

CkZip_put_PathPrefix $this $strVal
```

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.PwdProtCharset

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

```tcl
string
# ckStr is a CkString

CkZip_get_PwdProtCharset $this $ckStr

set strVal [CkZip_get_pwdProtCharset $this]

CkZip_put_PwdProtCharset $this $strVal
```

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 · tcl · Zip · TempDir · property · read/write`

```tcl
string
# ckStr is a CkString

CkZip_get_TempDir $this $ckStr

set strVal [CkZip_get_tempDir $this]

CkZip_put_TempDir $this $strVal
```

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 · tcl · Zip · UncommonOptions · property · read/write · since 9.5.0.84`

```tcl
string
# ckStr is a CkString

CkZip_get_UncommonOptions $this $ckStr

set strVal [CkZip_get_uncommonOptions $this]

CkZip_put_UncommonOptions $this $strVal
```

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 · tcl · Zip · Zipx · property · read/write`

```tcl
boolean 1/0
set boolVal [CkZip_get_Zipx $this]

CkZip_put_Zipx $this $boolVal
```

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

The default value is `0`.

### Zip.ZipxDefaultAlg

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

```tcl
string
# ckStr is a CkString

CkZip_get_ZipxDefaultAlg $this $ckStr

set strVal [CkZip_get_zipxDefaultAlg $this]

CkZip_put_ZipxDefaultAlg $this $strVal
```

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 · tcl · Zip · AddBd · method · since 11.0.0`

```tcl
# pathInZip is a string

# bd is a CkBinData

set status [CkZip_AddBd $this $pathInZip  $bd]
```

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 1 for success, 0 for failure.

### Zip.AddEmpty

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

```tcl
# isDir is a boolean

# pathInZip is a string

set status [CkZip_AddEmpty $this $isDir  $pathInZip]
```

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

- If `isDir = 1`, an empty directory entry is created.
- If `isDir = 0`, 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 1 for success, 0 for failure.

### Zip.AddEncoded

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

```tcl
# pathInZip is a string

# encoding is a string

# data is a string

set status [CkZip_AddEncoded $this $pathInZip  $encoding  $data]
```

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 1 for success, 0 for failure.

### Zip.AddFile

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

```tcl
# localPath is a string

# saveExtraPath is a boolean

set status [CkZip_AddFile $this $localPath  $saveExtraPath]
```

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

- If `localPath` is an absolute path and `saveExtraPath = 1`, the stored ZIP path includes the relative directory structure.
- If `saveExtraPath = 0`, 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 1 for success, 0 for failure.

### Zip.AddNoCompressExtension

`Chilkat 11.7.0 · tcl · Zip · AddNoCompressExtension · method`

```tcl
# fileExtension is a string

CkZip_AddNoCompressExtension $this $fileExtension
```

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 · tcl · Zip · AddSb · method · since 11.0.0`

```tcl
# pathInZip is a string

# sb is a CkStringBuilder

# charset is a string

set status [CkZip_AddSb $this $pathInZip  $sb  $charset]
```

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 1 for success, 0 for failure.

### Zip.AddString

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

```tcl
# pathInZip is a string

# content is a string

# charset is a string

set status [CkZip_AddString $this $pathInZip  $content  $charset]
```

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 1 for success, 0 for failure.

### Zip.AppendFiles

`Chilkat 11.7.0 · tcl · Zip · AppendFiles · method`

```tcl
# filePattern is a string

# recurse is a boolean

set status [CkZip_AppendFiles $this $filePattern  $recurse]
```

Adds one or more files matching a wildcard pattern.

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

For example:

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

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

Returns 1 for success, 0 for failure.

Async variant: `AppendFilesAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.AppendFilesEx

`Chilkat 11.7.0 · tcl · Zip · AppendFilesEx · method`

```tcl
# filePattern is a string

# recurse is a boolean

# saveExtraPath is a boolean

# archiveOnly is a boolean

# includeHidden is a boolean

# includeSystem is a boolean

set status [CkZip_AppendFilesEx $this $filePattern  $recurse  $saveExtraPath  $archiveOnly  $includeHidden  $includeSystem]
```

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 1 for success, 0 for failure.

Async variant: `AppendFilesExAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.AppendZip

`Chilkat 11.7.0 · tcl · Zip · AppendZip · method`

```tcl
# zipPath is a string

set status [CkZip_AppendZip $this $zipPath]
```

**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 1 for success, 0 for failure.

### Zip.CloseZip

`Chilkat 11.7.0 · tcl · Zip · CloseZip · method`

```tcl
CkZip_CloseZip $this
```

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 · tcl · Zip · DeleteEntry · method`

```tcl
# entry is a CkZipEntry

set status [CkZip_DeleteEntry $this $entry]
```

Removes a ZIP entry from the current ZIP object.

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

Returns 1 for success, 0 for failure.

### Zip.EntryAt

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

```tcl
# index is an integer

# entry is a CkZipEntry

set status [CkZip_EntryAt $this $index  $entry]
```

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 1 for success, 0 for failure.

### Zip.EntryById

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

```tcl
# id is an integer

# entry is a CkZipEntry

set status [CkZip_EntryById $this $id  $entry]
```

Finds a ZIP entry by its unique EntryID.

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

Returns 1 for success, 0 for failure.

### Zip.EntryMatching

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

```tcl
# pattern is a string

# entry is a CkZipEntry

set status [CkZip_EntryMatching $this $pattern  $entry]
```

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 1 for success, 0 for failure.

### Zip.EntryOf

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

```tcl
# pathInZip is a string

# entry is a CkZipEntry

set status [CkZip_EntryOf $this $pathInZip  $entry]
```

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

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

Returns 1 for success, 0 for failure.

### Zip.ExcludeDir

`Chilkat 11.7.0 · tcl · Zip · ExcludeDir · method`

```tcl
# dirName is a string

CkZip_ExcludeDir $this $dirName
```

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 · tcl · Zip · ExtractExe · method · since 9.5.0.44`

```tcl
# exePath is a string

# dirPath is a string

set status [CkZip_ExtractExe $this $exePath  $dirPath]
```

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 1 for success, 0 for failure.

Async variant: `ExtractExeAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.GetDirectoryAsXML

`Chilkat 11.7.0 · tcl · Zip · GetDirectoryAsXML · method`

```tcl
# outXml is a CkString (output)

set status [CkZip_GetDirectoryAsXML $this $outStr]

set retStr [CkZip_getDirectoryAsXML $this]
```

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 1 for success, 0 for failure.

### Zip.GetExeConfigParam

`Chilkat 11.7.0 · tcl · Zip · GetExeConfigParam · method`

```tcl
# name is a string

# outStr is a CkString (output)

set status [CkZip_GetExeConfigParam $this $name $outStr]

set retStr [CkZip_getExeConfigParam $this $name]
```

`(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 1 for success, 0 for failure.

### Zip.GetMaxUncompressedSize

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

```tcl
# outStr is a CkString (output)

set status [CkZip_GetMaxUncompressedSize $this $outStr]

set retStr [CkZip_getMaxUncompressedSize $this]
```

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 1 for success, 0 for failure.

### Zip.IsNoCompressExtension

`Chilkat 11.7.0 · tcl · Zip · IsNoCompressExtension · method`

```tcl
# fileExtension is a string

set retBool [CkZip_IsNoCompressExtension $this $fileExtension]
```

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 `1` if the extension exists in the list, otherwise returns `0`.

### Zip.IsPasswordProtected

`Chilkat 11.7.0 · tcl · Zip · IsPasswordProtected · method`

```tcl
# zipPath is a string

set retBool [CkZip_IsPasswordProtected $this $zipPath]
```

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 `1` if the ZIP archive is password protected, otherwise returns `0`.

### Zip.LoadTaskCaller

`Chilkat 11.7.0 · tcl · Zip · LoadTaskCaller · method · since 9.5.0.80`

```tcl
# task is a CkTask

set status [CkZip_LoadTaskCaller $this $task]
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

### Zip.NewZip

`Chilkat 11.7.0 · tcl · Zip · NewZip · method`

```tcl
# zipPath is a string

set status [CkZip_NewZip $this $zipPath]
```

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 1 for success, 0 for failure.

### Zip.OpenBd

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

```tcl
# binData is a CkBinData

set status [CkZip_OpenBd $this $binData]
```

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 1 for success, 0 for failure.

### Zip.OpenEmbedded

`Chilkat 11.7.0 · tcl · Zip · OpenEmbedded · method`

```tcl
# exeFilename is a string

# resourceName is a string

set status [CkZip_OpenEmbedded $this $exeFilename  $resourceName]
```

`(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 1 for success, 0 for failure.

### Zip.OpenZip

`Chilkat 11.7.0 · tcl · Zip · OpenZip · method`

```tcl
# zipPath is a string

set status [CkZip_OpenZip $this $zipPath]
```

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 1 for success, 0 for failure.

Async variant: `OpenZipAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.QuickAppend

`Chilkat 11.7.0 · tcl · Zip · QuickAppend · method`

```tcl
# zipPath is a string

set status [CkZip_QuickAppend $this $zipPath]
```

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 1 for success, 0 for failure.

Async variant: `QuickAppendAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.RemoveNoCompressExtension

`Chilkat 11.7.0 · tcl · Zip · RemoveNoCompressExtension · method`

```tcl
# fileExtension is a string

CkZip_RemoveNoCompressExtension $this $fileExtension
```

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 · tcl · Zip · SetCompressionLevel · method`

```tcl
# level is an integer

CkZip_SetCompressionLevel $this $level
```

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 · tcl · Zip · SetExclusions · method`

```tcl
# excludePatterns is a CkStringArray

CkZip_SetExclusions $this $excludePatterns
```

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 · tcl · Zip · SetExeConfigParam · method`

```tcl
# paramName is a string

# paramValue is a string

CkZip_SetExeConfigParam $this $paramName  $paramValue
```

`(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 · tcl · Zip · Unzip · method`

```tcl
# dirPath is a string

set retInt [CkZip_Unzip $this $dirPath]
```

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.

Async variant: `UnzipAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.UnzipInto

`Chilkat 11.7.0 · tcl · Zip · UnzipInto · method`

```tcl
# dirPath is a string

set retInt [CkZip_UnzipInto $this $dirPath]
```

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.

Async variant: `UnzipIntoAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.UnzipMatching

`Chilkat 11.7.0 · tcl · Zip · UnzipMatching · method`

```tcl
# dirPath is a string

# pattern is a string

# verbose is a boolean

set retInt [CkZip_UnzipMatching $this $dirPath  $pattern  $verbose]
```

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.

Async variant: `UnzipMatchingAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.UnzipMatchingInto

`Chilkat 11.7.0 · tcl · Zip · UnzipMatchingInto · method`

```tcl
# dirPath is a string

# pattern is a string

# verbose is a boolean

set retInt [CkZip_UnzipMatchingInto $this $dirPath  $pattern  $verbose]
```

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.

Async variant: `UnzipMatchingIntoAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.UnzipNewer

`Chilkat 11.7.0 · tcl · Zip · UnzipNewer · method`

```tcl
# dirPath is a string

set retInt [CkZip_UnzipNewer $this $dirPath]
```

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.

Async variant: `UnzipNewerAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.VerifyPassword

`Chilkat 11.7.0 · tcl · Zip · VerifyPassword · method`

```tcl
set retBool [CkZip_VerifyPassword $this]
```

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

This method allows password validation before attempting extraction.

Returns `1` if the password is valid, otherwise returns `0`.

### Zip.WriteBd

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

```tcl
# binData is a CkBinData

set status [CkZip_WriteBd $this $binData]
```

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 1 for success, 0 for failure.

Async variant: `WriteBdAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.WriteExe

`Chilkat 11.7.0 · tcl · Zip · WriteExe · method`

```tcl
# exeFilename is a string

set status [CkZip_WriteExe $this $exeFilename]
```

`(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 1 for success, 0 for failure.

Async variant: `WriteExeAsync` — same arguments, returns a `Task` (see Async variants below).

See also:

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

### Zip.WriteZip

`Chilkat 11.7.0 · tcl · Zip · WriteZip · method`

```tcl
set status [CkZip_WriteZip $this]
```

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 1 for success, 0 for failure.

Async variant: `WriteZipAsync` — same arguments, returns a `Task` (see Async variants below).

### Zip.WriteZipAndClose

`Chilkat 11.7.0 · tcl · Zip · WriteZipAndClose · method`

```tcl
set status [CkZip_WriteZipAndClose $this]
```

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 1 for success, 0 for failure.

Async variant: `WriteZipAndCloseAsync` — same arguments, returns a `Task` (see Async variants below).

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```tcl
# returns a CkTask

# filePattern is a string

# recurse is a boolean

set ret_task [CkZip_AppendFilesAsync $this $filePattern  $recurse]
# returns a CkTask

# filePattern is a string

# recurse is a boolean

# saveExtraPath is a boolean

# archiveOnly is a boolean

# includeHidden is a boolean

# includeSystem is a boolean

set ret_task [CkZip_AppendFilesExAsync $this $filePattern  $recurse  $saveExtraPath  $archiveOnly  $includeHidden  $includeSystem]
# returns a CkTask

# exePath is a string

# dirPath is a string

set ret_task [CkZip_ExtractExeAsync $this $exePath  $dirPath]
# returns a CkTask

# zipPath is a string

set ret_task [CkZip_OpenZipAsync $this $zipPath]
# returns a CkTask

# zipPath is a string

set ret_task [CkZip_QuickAppendAsync $this $zipPath]
# returns a CkTask

# dirPath is a string

set ret_task [CkZip_UnzipAsync $this $dirPath]
# returns a CkTask

# dirPath is a string

set ret_task [CkZip_UnzipIntoAsync $this $dirPath]
# returns a CkTask

# dirPath is a string

# pattern is a string

# verbose is a boolean

set ret_task [CkZip_UnzipMatchingAsync $this $dirPath  $pattern  $verbose]
# returns a CkTask

# dirPath is a string

# pattern is a string

# verbose is a boolean

set ret_task [CkZip_UnzipMatchingIntoAsync $this $dirPath  $pattern  $verbose]
# returns a CkTask

# dirPath is a string

set ret_task [CkZip_UnzipNewerAsync $this $dirPath]
# returns a CkTask

# binData is a CkBinData

set ret_task [CkZip_WriteBdAsync $this $binData]
# returns a CkTask

# exeFilename is a string

set ret_task [CkZip_WriteExeAsync $this $exeFilename]
# returns a CkTask

set ret_task [CkZip_WriteZipAsync $this]
# returns a CkTask

set ret_task [CkZip_WriteZipAndCloseAsync $this]
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `AppendBd` | method | before 11.6.1 | `AddBd` |
| `AppendData` | method | before 11.6.1 | `AddData` |
| `AppendDataEncoded` | method | before 11.6.1 | `AddEncoded` |
| `AppendNew` | method | before 11.6.1 | `AddEmpty` |
| `AppendNewDir` | method | before 11.6.1 | `AddEmpty` |
| `AppendOneFileOrDir` | method | before 11.6.1 | `AddFile` |
| `AppendSb` | method | before 11.6.1 | `AddSb` |
| `AppendString` | method | before 11.6.1 | `AddString` |
| `AppendString2` | method | before 11.6.1 | `AddString` |
| `FirstEntry` | method | before 11.6.1 | `EntryAt` |
| `FirstMatchingEntry` | method | before 11.6.1 | `EntryMatching` |
| `GetEntryByID` | method | before 11.6.1 | `EntryById` |
| `GetEntryByIndex` | method | before 11.6.1 | `EntryAt` |
| `GetEntryByName` | method | before 11.6.1 | `EntryOf` |
| `GetExclusions` | method | before 11.6.1 | — |
| `OpenFromByteData` | method | before 11.6.1 | — |
| `OpenFromMemory` | method | before 11.6.1 | — |
| `SetPassword` | method | before 11.6.1 | — |
| `WriteExeToMemory` | method | before 11.6.1 | — |
| `WriteToMemory` | method | before 11.6.1 | — |

## Related classes

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