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

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

```powerbuilder
oleobject loo_Zip
integer li_rc

loo_Zip = create oleobject
li_rc = loo_Zip.ConnectToNewObject("Chilkat.Zip")
if li_rc < 0 then
    destroy loo_Zip
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_Zip ...

destroy loo_Zip
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.Zip.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

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

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 DebugLogFilePath` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `blob LastBinaryResult (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `string LastErrorHtml (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string LastErrorText (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string LastErrorXml (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `long LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `string LastStringResult (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `long LastStringResultLen (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `long VerboseLogging` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string Version (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `long AbortCurrent` |
| `AppendFromDir` | property, read/write | `string AppendFromDir` |
| `AutoRun` | property, read/write | `string AutoRun` |
| `AutoRunParams` | property, read/write | `string AutoRunParams` |
| `AutoTemp` | property, read/write | `long AutoTemp` |
| `CaseSensitive` | property, read/write | `long CaseSensitive` |
| `ClearArchiveAttribute` | property, read/write | `long ClearArchiveAttribute` |
| `ClearReadOnlyAttr` | property, read/write | `long ClearReadOnlyAttr` |
| `Comment` | property, read/write | `string Comment` |
| `DecryptPassword` | property, read/write | `string DecryptPassword` |
| `DiscardPaths` | property, read/write | `long DiscardPaths` |
| `Encryption` | property, read/write | `long Encryption` |
| `EncryptKeyLength` | property, read/write | `long EncryptKeyLength` |
| `EncryptPassword` | property, read/write | `string EncryptPassword` |
| `ExeDefaultDir` | property, read/write | `string ExeDefaultDir` |
| `ExeFinishNotifier` | property, read/write | `long ExeFinishNotifier` |
| `ExeIconFile` | property, read/write | `string ExeIconFile` |
| `ExeNoInterface` | property, read/write | `long ExeNoInterface` |
| `ExeSilentProgress` | property, read/write | `long ExeSilentProgress` |
| `ExeTitle` | property, read/write | `string ExeTitle` |
| `ExeUnzipCaption` | property, read/write | `string ExeUnzipCaption` |
| `ExeUnzipDir` | property, read/write | `string ExeUnzipDir` |
| `ExeWaitForSetup` | property, read/write | `long ExeWaitForSetup` |
| `ExeXmlConfig` | property, read/write | `string ExeXmlConfig` |
| `FileCount` | property, read-only | `long FileCount (read-only)` |
| `FileName` | property, read/write | `string FileName` |
| `HasZipFormatErrors` | property, read-only | `long HasZipFormatErrors (read-only)` |
| `IgnoreAccessDenied` | property, read/write | `long IgnoreAccessDenied` |
| `MaxDate` | property, read/write | `string MaxDate` |
| `MaxUncompressSize` | property, read/write | `long MaxUncompressSize` |
| `MinDate` | property, read/write | `string MinDate` |
| `NumEntries` | property, read-only | `long NumEntries (read-only)` |
| `OemCodePage` | property, read/write | `long OemCodePage` |
| `OverwriteExisting` | property, read/write | `long OverwriteExisting` |
| `PasswordProtect` | property, read/write | `long PasswordProtect` |
| `PathPrefix` | property, read/write | `string PathPrefix` |
| `PwdProtCharset` | property, read/write | `string PwdProtCharset` |
| `TempDir` | property, read/write | `string TempDir` |
| `UncommonOptions` | property, read/write | `string UncommonOptions` |
| `Zipx` | property, read/write | `long Zipx` |
| `ZipxDefaultAlg` | property, read/write | `string ZipxDefaultAlg` |
| `AddBd` | method | `long AddBd(string pathInZip, ChilkatBinData bd)` |
| `AddEmpty` | method | `long AddEmpty(long isDir, string pathInZip)` |
| `AddEncoded` | method | `long AddEncoded(string pathInZip, string encoding, string data)` |
| `AddFile` | method | `long AddFile(string localPath, long saveExtraPath)` |
| `AddNoCompressExtension` | method | `AddNoCompressExtension(string fileExtension)` |
| `AddSb` | method | `long AddSb(string pathInZip, ChilkatStringBuilder sb, string charset)` |
| `AddString` | method | `long AddString(string pathInZip, string content, string charset)` |
| `AppendFiles` | method | `long AppendFiles(string filePattern, long recurse)` |
| `AppendFilesEx` | method | `long AppendFilesEx(string filePattern, long recurse, long saveExtraPath, long archiveOnly, long includeHidden, long includeSystem)` |
| `AppendZip` | method | `long AppendZip(string zipPath)` |
| `CloseZip` | method | `CloseZip()` |
| `DeleteEntry` | method | `long DeleteEntry(ChilkatZipEntry entry)` |
| `EntryAt` | method | `long EntryAt(long index, ChilkatZipEntry entry)` |
| `EntryById` | method | `long EntryById(long id, ChilkatZipEntry entry)` |
| `EntryMatching` | method | `long EntryMatching(string pattern, ChilkatZipEntry entry)` |
| `EntryOf` | method | `long EntryOf(string pathInZip, ChilkatZipEntry entry)` |
| `ExcludeDir` | method | `ExcludeDir(string dirName)` |
| `ExtractExe` | method | `long ExtractExe(string exePath, string dirPath)` |
| `GetDirectoryAsXML` | method | `string GetDirectoryAsXML()` |
| `GetExeConfigParam` | method | `string GetExeConfigParam(string name)` |
| `GetMaxUncompressedSize` | method | `string GetMaxUncompressedSize()` |
| `IsNoCompressExtension` | method | `long IsNoCompressExtension(string fileExtension)` |
| `IsPasswordProtected` | method | `long IsPasswordProtected(string zipPath)` |
| `LoadTaskCaller` | method | `long LoadTaskCaller(ChilkatTask task)` |
| `NewZip` | method | `long NewZip(string zipPath)` |
| `OpenBd` | method | `long OpenBd(ChilkatBinData binData)` |
| `OpenEmbedded` | method | `long OpenEmbedded(string exeFilename, string resourceName)` |
| `OpenFromByteData` | method | `long OpenFromByteData(blob byteData)` |
| `OpenFromMemory` | method | `long OpenFromMemory(blob inData)` |
| `OpenZip` | method | `long OpenZip(string zipPath)` |
| `QuickAppend` | method | `long QuickAppend(string zipPath)` |
| `RemoveNoCompressExtension` | method | `RemoveNoCompressExtension(string fileExtension)` |
| `SetCompressionLevel` | method | `SetCompressionLevel(long level)` |
| `SetExclusions` | method | `SetExclusions(CkStringArray excludePatterns)` |
| `SetExeConfigParam` | method | `SetExeConfigParam(string paramName, string paramValue)` |
| `Unzip` | method | `long Unzip(string dirPath)` |
| `UnzipInto` | method | `long UnzipInto(string dirPath)` |
| `UnzipMatching` | method | `long UnzipMatching(string dirPath, string pattern, long verbose)` |
| `UnzipMatchingInto` | method | `long UnzipMatchingInto(string dirPath, string pattern, long verbose)` |
| `UnzipNewer` | method | `long UnzipNewer(string dirPath)` |
| `VerifyPassword` | method | `long VerifyPassword()` |
| `WriteBd` | method | `long WriteBd(ChilkatBinData binData)` |
| `WriteExe` | method | `long WriteExe(string exeFilename)` |
| `WriteExeToMemory` | method | `blob WriteExeToMemory()` |
| `WriteToMemory` | method | `blob WriteToMemory()` |
| `WriteZip` | method | `long WriteZip()` |
| `WriteZipAndClose` | method | `long WriteZipAndClose()` |

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 · powerbuilder · Zip · AbortCurrent · property · read/write · since 9.5.0.58`

```powerbuilder
long AbortCurrent
```

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 · powerbuilder · Zip · AppendFromDir · property · read/write`

```powerbuilder
string AppendFromDir
```

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

```powerbuilder
string AutoRun
```

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

```powerbuilder
string AutoRunParams
```

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

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

### Zip.AutoTemp

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

```powerbuilder
long AutoTemp
```

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

```powerbuilder
long CaseSensitive
```

Controls whether filename matching is case-sensitive.

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

### Zip.ClearArchiveAttribute

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

```powerbuilder
long ClearArchiveAttribute
```

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

```powerbuilder
long ClearReadOnlyAttr
```

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 · powerbuilder · Zip · Comment · property · read/write`

```powerbuilder
string Comment
```

Sets or retrieves the global ZIP file comment.

The default value is the empty string.

### Zip.DecryptPassword

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

```powerbuilder
string DecryptPassword
```

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

```powerbuilder
long DiscardPaths
```

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 · powerbuilder · Zip · Encryption · property · read/write`

```powerbuilder
long Encryption
```

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 · powerbuilder · Zip · EncryptKeyLength · property · read/write`

```powerbuilder
long EncryptKeyLength
```

Specifies the AES encryption key length.

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

The default value is `128`.

### Zip.EncryptPassword

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

```powerbuilder
string EncryptPassword
```

Password used when creating encrypted ZIP archives.

The default value is the empty string.

### Zip.ExeDefaultDir

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

```powerbuilder
string ExeDefaultDir
```

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

```powerbuilder
long ExeFinishNotifier
```

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

```powerbuilder
string ExeIconFile
```

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

```powerbuilder
long ExeNoInterface
```

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

```powerbuilder
long ExeSilentProgress
```

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

```powerbuilder
string ExeTitle
```

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

```powerbuilder
string ExeUnzipCaption
```

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

```powerbuilder
string ExeUnzipDir
```

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

```powerbuilder
long ExeWaitForSetup
```

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 · powerbuilder · Zip · ExeXmlConfig · property · read/write`

```powerbuilder
string ExeXmlConfig
```

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

```powerbuilder
long FileCount (read-only)
```

Number of files in the ZIP, excluding directory entries.

### Zip.FileName

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

```powerbuilder
string FileName
```

Path of the ZIP file to be written or overwritten.

The default value is the empty string.

### Zip.HasZipFormatErrors

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

```powerbuilder
long HasZipFormatErrors (read-only)
```

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

### Zip.IgnoreAccessDenied

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

```powerbuilder
long IgnoreAccessDenied
```

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

```powerbuilder
string MaxDate
```

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

```powerbuilder
long MaxUncompressSize
```

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

```powerbuilder
string MinDate
```

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

```powerbuilder
long NumEntries (read-only)
```

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

### Zip.OemCodePage

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

```powerbuilder
long OemCodePage
```

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

```powerbuilder
long OverwriteExisting
```

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

The default value is `1`.

### Zip.PasswordProtect

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

```powerbuilder
long PasswordProtect
```

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 · powerbuilder · Zip · PathPrefix · property · read/write`

```powerbuilder
string PathPrefix
```

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 · powerbuilder · Zip · PwdProtCharset · property · read/write · since 9.5.0.73`

```powerbuilder
string PwdProtCharset
```

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

```powerbuilder
string TempDir
```

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

```powerbuilder
string UncommonOptions
```

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

```powerbuilder
long Zipx
```

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 · powerbuilder · Zip · ZipxDefaultAlg · property · read/write`

```powerbuilder
string ZipxDefaultAlg
```

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

```powerbuilder
long AddBd(string pathInZip, ChilkatBinData 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 · powerbuilder · Zip · AddEmpty · method · since 11.0.0`

```powerbuilder
long AddEmpty(long isDir, string 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 · powerbuilder · Zip · AddEncoded · method · since 11.0.0`

```powerbuilder
long AddEncoded(string pathInZip, string encoding, string 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 · powerbuilder · Zip · AddFile · method · since 11.0.0`

```powerbuilder
long AddFile(string localPath, long 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 · powerbuilder · Zip · AddNoCompressExtension · method`

```powerbuilder
AddNoCompressExtension(string 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 · powerbuilder · Zip · AddSb · method · since 11.0.0`

```powerbuilder
long AddSb(string pathInZip, ChilkatStringBuilder sb, string 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 · powerbuilder · Zip · AddString · method · since 11.0.0`

```powerbuilder
long AddString(string pathInZip, string content, string 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 · powerbuilder · Zip · AppendFiles · method`

```powerbuilder
long AppendFiles(string filePattern, long 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 · powerbuilder · Zip · AppendFilesEx · method`

```powerbuilder
long AppendFilesEx(string filePattern, long recurse, long saveExtraPath, long archiveOnly, long includeHidden, long 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 · powerbuilder · Zip · AppendZip · method`

```powerbuilder
long AppendZip(string 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 · powerbuilder · Zip · CloseZip · method`

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

```powerbuilder
long DeleteEntry(ChilkatZipEntry 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 · powerbuilder · Zip · EntryAt · method · since 11.0.0`

```powerbuilder
long EntryAt(long index, ChilkatZipEntry 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 · powerbuilder · Zip · EntryById · method · since 11.0.0`

```powerbuilder
long EntryById(long id, ChilkatZipEntry 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 · powerbuilder · Zip · EntryMatching · method · since 11.0.0`

```powerbuilder
long EntryMatching(string pattern, ChilkatZipEntry 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 · powerbuilder · Zip · EntryOf · method · since 11.0.0`

```powerbuilder
long EntryOf(string pathInZip, ChilkatZipEntry 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 · powerbuilder · Zip · ExcludeDir · method`

```powerbuilder
ExcludeDir(string 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 · powerbuilder · Zip · ExtractExe · method · since 9.5.0.44`

```powerbuilder
long ExtractExe(string exePath, string 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 · powerbuilder · Zip · GetDirectoryAsXML · method`

```powerbuilder
string GetDirectoryAsXML()
```

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 `null` on failure

### Zip.GetExeConfigParam

`Chilkat 11.7.0 · powerbuilder · Zip · GetExeConfigParam · method`

```powerbuilder
string GetExeConfigParam(string 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 `null` on failure

### Zip.GetMaxUncompressedSize

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

```powerbuilder
string GetMaxUncompressedSize()
```

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 `null` on failure

### Zip.IsNoCompressExtension

`Chilkat 11.7.0 · powerbuilder · Zip · IsNoCompressExtension · method`

```powerbuilder
long IsNoCompressExtension(string 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 · powerbuilder · Zip · IsPasswordProtected · method`

```powerbuilder
long IsPasswordProtected(string 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 · powerbuilder · Zip · LoadTaskCaller · method · since 9.5.0.80`

```powerbuilder
long LoadTaskCaller(ChilkatTask task)
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

### Zip.NewZip

`Chilkat 11.7.0 · powerbuilder · Zip · NewZip · method`

```powerbuilder
long NewZip(string 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 · powerbuilder · Zip · OpenBd · method · since 9.5.0.66`

```powerbuilder
long OpenBd(ChilkatBinData 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 · powerbuilder · Zip · OpenEmbedded · method`

```powerbuilder
long OpenEmbedded(string exeFilename, string 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.OpenFromByteData

`Chilkat 11.7.0 · powerbuilder · Zip · OpenFromByteData · method`

```powerbuilder
long OpenFromByteData(blob byteData)
```

Opens a ZIP archive from in-memory byte data.

When the ZIP archive is opened:

- `PasswordProtect` is automatically set if legacy password protection is detected.
- `Encryption` is automatically set if strong encryption is detected.
- `Encryption = 4` indicates AES encryption.

Returns 1 for success, 0 for failure.

### Zip.OpenFromMemory

`Chilkat 11.7.0 · powerbuilder · Zip · OpenFromMemory · method`

```powerbuilder
long OpenFromMemory(blob inData)
```

Opens a ZIP archive directly from in-memory binary data.

This allows ZIP processing without using filesystem files.

Typical use cases include:

- ZIP data loaded from a database
- ZIP data received from HTTP responses
- ZIP data stored entirely in memory

When the ZIP archive is opened:

- `PasswordProtect` is automatically set if Zip 2.0 encryption is detected.
- `Encryption` is automatically set if strong encryption is detected.

Returns 1 for success, 0 for failure.

### Zip.OpenZip

`Chilkat 11.7.0 · powerbuilder · Zip · OpenZip · method`

```powerbuilder
long OpenZip(string 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 · powerbuilder · Zip · QuickAppend · method`

```powerbuilder
long QuickAppend(string 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 · powerbuilder · Zip · RemoveNoCompressExtension · method`

```powerbuilder
RemoveNoCompressExtension(string 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 · powerbuilder · Zip · SetCompressionLevel · method`

```powerbuilder
SetCompressionLevel(long 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 · powerbuilder · Zip · SetExclusions · method`

```powerbuilder
SetExclusions(CkStringArray 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 · powerbuilder · Zip · SetExeConfigParam · method`

```powerbuilder
SetExeConfigParam(string paramName, string 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 · powerbuilder · Zip · Unzip · method`

```powerbuilder
long Unzip(string 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 · powerbuilder · Zip · UnzipInto · method`

```powerbuilder
long UnzipInto(string 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 · powerbuilder · Zip · UnzipMatching · method`

```powerbuilder
long UnzipMatching(string dirPath, string pattern, long 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 · powerbuilder · Zip · UnzipMatchingInto · method`

```powerbuilder
long UnzipMatchingInto(string dirPath, string pattern, long 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 · powerbuilder · Zip · UnzipNewer · method`

```powerbuilder
long UnzipNewer(string 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 · powerbuilder · Zip · VerifyPassword · method`

```powerbuilder
long VerifyPassword()
```

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 · powerbuilder · Zip · WriteBd · method · since 9.5.0.66`

```powerbuilder
long WriteBd(ChilkatBinData 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 · powerbuilder · Zip · WriteExe · method`

```powerbuilder
long WriteExe(string 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.WriteExeToMemory

`Chilkat 11.7.0 · powerbuilder · Zip · WriteExeToMemory · method`

```powerbuilder
blob WriteExeToMemory()
```

(Relevant only when running on a Microsoft Windows operating system.) Same as WriteExe, but instead of writing a file, the MS-Windows EXE is written to memory.

Returns a zero-length byte array (as a Variant) on failure.

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

See also:

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

### Zip.WriteToMemory

`Chilkat 11.7.0 · powerbuilder · Zip · WriteToMemory · method`

```powerbuilder
blob WriteToMemory()
```

Same as WriteZip, but instead of writing the Zip to a file, it writes to memory. Zips that are written to memory can also be opened from memory by calling OpenFromMemory.

Returns a zero-length byte array (as a Variant) on failure.

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

### Zip.WriteZip

`Chilkat 11.7.0 · powerbuilder · Zip · WriteZip · method`

```powerbuilder
long WriteZip()
```

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 · powerbuilder · Zip · WriteZipAndClose · method`

```powerbuilder
long WriteZipAndClose()
```

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.

```powerbuilder
ChilkatTask AppendFilesAsync(string filePattern, long recurse)
ChilkatTask AppendFilesExAsync(string filePattern, long recurse, long saveExtraPath, long archiveOnly, long includeHidden, long includeSystem)
ChilkatTask ExtractExeAsync(string exePath, string dirPath)
ChilkatTask OpenZipAsync(string zipPath)
ChilkatTask QuickAppendAsync(string zipPath)
ChilkatTask UnzipAsync(string dirPath)
ChilkatTask UnzipIntoAsync(string dirPath)
ChilkatTask UnzipMatchingAsync(string dirPath, string pattern, long verbose)
ChilkatTask UnzipMatchingIntoAsync(string dirPath, string pattern, long verbose)
ChilkatTask UnzipNewerAsync(string dirPath)
ChilkatTask WriteBdAsync(ChilkatBinData binData)
ChilkatTask WriteExeAsync(string exeFilename)
ChilkatTask WriteExeToMemoryAsync()
ChilkatTask WriteToMemoryAsync()
ChilkatTask WriteZipAsync()
ChilkatTask WriteZipAndCloseAsync()
```

## 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 | — |
| `SetPassword` | method | before 11.6.1 | — |

## Related classes

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

