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

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

## Purpose

**Inspect, extract, update, and iterate individual entries inside a ZIP archive.**

`Chilkat.ZipEntry` represents a single item associated with a `Chilkat.Zip` archive. An entry may be a file already stored in an opened ZIP, a referenced filesystem file waiting to be compressed, an in-memory text or binary entry, or a directory entry. It provides access to entry-level metadata, compressed and uncompressed data, timestamps, attributes, CRC values, encryption information, and extraction or replacement operations for that specific ZIP item.

**Entry metadata**

Inspect filenames, stored ZIP paths, comments, timestamps, CRC values, attributes, sizes, compression method, and compression level.

**Entry type and state**

Use `EntryType` to understand whether the entry comes from an existing ZIP, a filesystem reference, memory data, or a directory.

**Extract one entry**

Extract a selected file entry to disk, inflate its contents into memory, or read the uncompressed data into Chilkat objects.

**Read compressed data**

Access the raw compressed entry data when an application needs ZIP-level control rather than only the inflated contents.

**Replace or append data**

Update an entry's contents from strings, byte data, files, or in-memory data sources before writing the ZIP archive.

**Iterate archive entries**

Walk through entries returned from `Chilkat.Zip` methods to inspect, filter, extract, or modify ZIP contents one item at a time.

**Common pattern:** Open or create a `Chilkat.Zip` object, obtain a `ZipEntry` using methods such as `EntryAt`, `EntryOf`, `EntryMatching`, or `FirstEntry`, then inspect metadata, extract contents, update the entry, or continue iterating through the archive. Use `Chilkat.Zip` for whole-archive operations and `ZipEntry` for operations on one specific archive item.

For an extended overview, see [ZipEntry Overview](https://www.chilkatsoft.com/zipEntry_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```powerbuilder
oleobject loo_ZipEntry
integer li_rc

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

// ... use loo_ZipEntry ...

destroy loo_ZipEntry
```

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.ZipEntry.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 |
|---|---|---|
| `Comment` | property, read/write | `string Comment` |
| `CompressedLength` | property, read-only | `long CompressedLength (read-only)` |
| `CompressedLengthStr` | property, read-only | `string CompressedLengthStr (read-only)` |
| `CompressionLevel` | property, read/write | `long CompressionLevel` |
| `CompressionMethod` | property, read/write | `long CompressionMethod` |
| `Crc` | property, read-only | `long Crc (read-only)` |
| `EncryptionKeyLen` | property, read-only | `long EncryptionKeyLen (read-only)` |
| `EntryID` | property, read-only | `long EntryID (read-only)` |
| `EntryType` | property, read-only | `long EntryType (read-only)` |
| `FileDateTimeStr` | property, read/write | `string FileDateTimeStr` |
| `FileName` | property, read/write | `string FileName` |
| `FileNameHex` | property, read-only | `string FileNameHex (read-only)` |
| `IsAesEncrypted` | property, read-only | `long IsAesEncrypted (read-only)` |
| `IsDirectory` | property, read-only | `long IsDirectory (read-only)` |
| `TextFlag` | property, read/write | `long TextFlag` |
| `UncompressedLength` | property, read-only | `long UncompressedLength (read-only)` |
| `UncompressedLengthStr` | property, read-only | `string UncompressedLengthStr (read-only)` |
| `AppendData` | method | `long AppendData(blob inData)` |
| `AppendString` | method | `long AppendString(string strContent, string charset)` |
| `Copy` | method | `blob Copy()` |
| `CopyToBase64` | method | `string CopyToBase64()` |
| `CopyToHex` | method | `string CopyToHex()` |
| `Extract` | method | `long Extract(string dirPath)` |
| `ExtractInto` | method | `long ExtractInto(string dirPath)` |
| `GetNext` | method | `long GetNext()` |
| `GetNextMatch` | method | `long GetNextMatch(string pattern)` |
| `Inflate` | method | `blob Inflate()` |
| `LoadTaskCaller` | method | `long LoadTaskCaller(ChilkatTask task)` |
| `ReplaceData` | method | `long ReplaceData(blob inData)` |
| `ReplaceString` | method | `long ReplaceString(string strContent, string charset)` |
| `SetDt` | method | `SetDt(CkDateTime dt)` |
| `UnzipToBd` | method | `long UnzipToBd(ChilkatBinData binData)` |
| `UnzipToSb` | method | `long UnzipToSb(long lineEndingBehavior, string srcCharset, ChilkatStringBuilder sb)` |
| `UnzipToStream` | method | `long UnzipToStream(ChilkatStream toStream)` |
| `UnzipToString` | method | `string UnzipToString(long lineEndingBehavior, string srcCharset)` |

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

## Properties

### ZipEntry.Comment

`Chilkat 11.7.0 · powerbuilder · ZipEntry · Comment · property · read/write`

```powerbuilder
string Comment
```

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

### ZipEntry.CompressedLength

`Chilkat 11.7.0 · powerbuilder · ZipEntry · CompressedLength · property · read-only`

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

The compressed size of this entry, in bytes.

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

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

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

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

### ZipEntry.CompressedLengthStr

`Chilkat 11.7.0 · powerbuilder · ZipEntry · CompressedLengthStr · property · read-only`

```powerbuilder
string CompressedLengthStr (read-only)
```

The compressed size of this entry as a decimal string.

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

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

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

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

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

### ZipEntry.CompressionLevel

`Chilkat 11.7.0 · powerbuilder · ZipEntry · CompressionLevel · property · read/write`

```powerbuilder
long CompressionLevel
```

Gets or sets the compression level for this entry.

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

The default value is `6`.

### ZipEntry.CompressionMethod

`Chilkat 11.7.0 · powerbuilder · ZipEntry · CompressionMethod · property · read/write`

```powerbuilder
long CompressionMethod
```

Gets or sets the compression method used for this entry.

- `0` means no compression.
- `8` means Deflate compression.

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

### ZipEntry.Crc

`Chilkat 11.7.0 · powerbuilder · ZipEntry · Crc · property · read-only`

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

The CRC value for this ZIP entry.

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

### ZipEntry.EncryptionKeyLen

`Chilkat 11.7.0 · powerbuilder · ZipEntry · EncryptionKeyLen · property · read-only · since 9.5.0.69`

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

The AES encryption key length for this entry.

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

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

### ZipEntry.EntryID

`Chilkat 11.7.0 · powerbuilder · ZipEntry · EntryID · property · read-only`

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

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

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

### ZipEntry.EntryType

`Chilkat 11.7.0 · powerbuilder · ZipEntry · EntryType · property · read-only`

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

Indicates the origin and current state of this ZIP entry.

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

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

### ZipEntry.FileDateTimeStr

`Chilkat 11.7.0 · powerbuilder · ZipEntry · FileDateTimeStr · property · read/write`

```powerbuilder
string FileDateTimeStr
```

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

Example RFC 822 date/time strings:

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

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

### ZipEntry.FileName

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

```powerbuilder
string FileName
```

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

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

### ZipEntry.FileNameHex

`Chilkat 11.7.0 · powerbuilder · ZipEntry · FileNameHex · property · read-only`

```powerbuilder
string FileNameHex (read-only)
```

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

This can be useful for diagnosing filename encoding issues.

### ZipEntry.IsAesEncrypted

`Chilkat 11.7.0 · powerbuilder · ZipEntry · IsAesEncrypted · property · read-only · since 9.5.0.69`

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

Indicates whether this ZIP entry is AES encrypted.

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

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

### ZipEntry.IsDirectory

`Chilkat 11.7.0 · powerbuilder · ZipEntry · IsDirectory · property · read-only`

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

Indicates whether this ZIP entry is a directory entry.

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

### ZipEntry.TextFlag

`Chilkat 11.7.0 · powerbuilder · ZipEntry · TextFlag · property · read/write`

```powerbuilder
long TextFlag
```

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

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

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

### ZipEntry.UncompressedLength

`Chilkat 11.7.0 · powerbuilder · ZipEntry · UncompressedLength · property · read-only`

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

The uncompressed size of this entry, in bytes.

### ZipEntry.UncompressedLengthStr

`Chilkat 11.7.0 · powerbuilder · ZipEntry · UncompressedLengthStr · property · read-only`

```powerbuilder
string UncompressedLengthStr (read-only)
```

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

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

## Methods

### ZipEntry.AppendData

`Chilkat 11.7.0 · powerbuilder · ZipEntry · AppendData · method`

```powerbuilder
long AppendData(blob inData)
```

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

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

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

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

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

Returns 1 for success, 0 for failure.

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

### ZipEntry.AppendString

`Chilkat 11.7.0 · powerbuilder · ZipEntry · AppendString · method`

```powerbuilder
long AppendString(string strContent, string charset)
```

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

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

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

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

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

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

Returns 1 for success, 0 for failure.

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

### ZipEntry.Copy

`Chilkat 11.7.0 · powerbuilder · ZipEntry · Copy · method`

```powerbuilder
blob Copy()
```

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

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

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

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

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

### ZipEntry.CopyToBase64

`Chilkat 11.7.0 · powerbuilder · ZipEntry · CopyToBase64 · method`

```powerbuilder
string CopyToBase64()
```

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

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

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

Returns `null` on failure

### ZipEntry.CopyToHex

`Chilkat 11.7.0 · powerbuilder · ZipEntry · CopyToHex · method`

```powerbuilder
string CopyToHex()
```

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

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

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

Returns `null` on failure

### ZipEntry.Extract

`Chilkat 11.7.0 · powerbuilder · ZipEntry · Extract · method`

```powerbuilder
long Extract(string dirPath)
```

Extracts this ZIP entry beneath the specified base directory.

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

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

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

Returns 1 for success, 0 for failure.

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

### ZipEntry.ExtractInto

`Chilkat 11.7.0 · powerbuilder · ZipEntry · ExtractInto · method`

```powerbuilder
long ExtractInto(string dirPath)
```

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

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

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

Returns 1 for success, 0 for failure.

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

### ZipEntry.GetNext

`Chilkat 11.7.0 · powerbuilder · ZipEntry · GetNext · method · since 11.0.0`

```powerbuilder
long GetNext()
```

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

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

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

### ZipEntry.GetNextMatch

`Chilkat 11.7.0 · powerbuilder · ZipEntry · GetNextMatch · method · since 11.0.0`

```powerbuilder
long GetNextMatch(string pattern)
```

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

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

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

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

### ZipEntry.Inflate

`Chilkat 11.7.0 · powerbuilder · ZipEntry · Inflate · method`

```powerbuilder
blob Inflate()
```

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

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

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

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

### ZipEntry.LoadTaskCaller

`Chilkat 11.7.0 · powerbuilder · ZipEntry · 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.

### ZipEntry.ReplaceData

`Chilkat 11.7.0 · powerbuilder · ZipEntry · ReplaceData · method`

```powerbuilder
long ReplaceData(blob inData)
```

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

The new data becomes the complete contents of the entry.

Returns 1 for success, 0 for failure.

### ZipEntry.ReplaceString

`Chilkat 11.7.0 · powerbuilder · ZipEntry · ReplaceString · method`

```powerbuilder
long ReplaceString(string strContent, string charset)
```

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

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

The resulting bytes become the complete contents of the entry.

Returns 1 for success, 0 for failure.

### ZipEntry.SetDt

`Chilkat 11.7.0 · powerbuilder · ZipEntry · SetDt · method`

```powerbuilder
SetDt(CkDateTime dt)
```

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

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

### ZipEntry.UnzipToBd

`Chilkat 11.7.0 · powerbuilder · ZipEntry · UnzipToBd · method · since 9.5.0.67`

```powerbuilder
long UnzipToBd(ChilkatBinData binData)
```

Unzips this entry directly into a `BinData` object.

The uncompressed bytes are written to `binData`.

Returns 1 for success, 0 for failure.

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

### ZipEntry.UnzipToSb

`Chilkat 11.7.0 · powerbuilder · ZipEntry · UnzipToSb · method · since 9.5.0.67`

```powerbuilder
long UnzipToSb(long lineEndingBehavior, string srcCharset, ChilkatStringBuilder sb)
```

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

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

The `lineEndingBehavior` argument controls line-ending conversion:

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

Returns 1 for success, 0 for failure.

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

### ZipEntry.UnzipToStream

`Chilkat 11.7.0 · powerbuilder · ZipEntry · UnzipToStream · method · since 9.5.0.67`

```powerbuilder
long UnzipToStream(ChilkatStream toStream)
```

Unzips this entry to a stream.

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

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

Returns 1 for success, 0 for failure.

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

### ZipEntry.UnzipToString

`Chilkat 11.7.0 · powerbuilder · ZipEntry · UnzipToString · method`

```powerbuilder
string UnzipToString(long lineEndingBehavior, string srcCharset)
```

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

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

The `lineEndingBehavior` argument controls line-ending conversion:

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

Returns `null` on failure

Async variant: `UnzipToStringAsync` — 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 AppendDataAsync(blob inData)
ChilkatTask AppendStringAsync(string strContent, string charset)
ChilkatTask ExtractAsync(string dirPath)
ChilkatTask ExtractIntoAsync(string dirPath)
ChilkatTask InflateAsync()
ChilkatTask UnzipToBdAsync(ChilkatBinData binData)
ChilkatTask UnzipToSbAsync(long lineEndingBehavior, string srcCharset, ChilkatStringBuilder sb)
ChilkatTask UnzipToStreamAsync(ChilkatStream toStream)
ChilkatTask UnzipToStringAsync(long lineEndingBehavior, string srcCharset)
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `GetDt` | method | before 11.6.1 | — |
| `NextEntry` | method | before 11.6.1 | `GetNext` |
| `NextMatchingEntry` | method | before 11.6.1 | `GetNextMatch` |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/CkDateTime.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/powerbuilder/classes/Stream.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)

