---
product: Chilkat
product_version: 11.7.0
language: wcpp
language_label: Unicode C++
class: ZipEntry
class_name: CkZipEntryW
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/wcppCkZipEntryWRef.html
---
# Chilkat ZipEntry — Unicode C++ — v11.7.0

> Chilkat 11.7.0 · language=wcpp · class=ZipEntry (CkZipEntryW)
> 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/wcpp/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**

```cpp
// Local variable on the stack
CkZipEntryW obj;

// Dynamically allocate/delete
CkZipEntryW *pObj = new CkZipEntryW();
// ...
delete pObj;
```

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 Unicode C++.

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` | `void get_DebugLogFilePath(CkString &str); const wchar_t *debugLogFilePath(void); void put_DebugLogFilePath(const wchar_t *str);` | 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` | `void get_LastErrorHtml(CkString &str); const wchar_t *lastErrorHtml(void);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void get_LastErrorText(CkString &str); const wchar_t *lastErrorText(void);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void get_LastErrorXml(CkString &str); const wchar_t *lastErrorXml(void);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bool get_LastMethodSuccess(void); void put_LastMethodSuccess(bool newVal);` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `bool get_VerboseLogging(void); void put_VerboseLogging(bool newVal);` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void get_Version(CkString &str); const wchar_t *version(void);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Comment` | property, read/write | `void get_Comment(CkString &str); const wchar_t *comment(void); void put_Comment(const wchar_t *str);` |
| `CompressedLength` | property, read-only | `unsigned long get_CompressedLength(void);` |
| `CompressedLength64` | property, read-only | `__int64 get_CompressedLength64(void);` |
| `CompressedLengthStr` | property, read-only | `void get_CompressedLengthStr(CkString &str); const wchar_t *compressedLengthStr(void);` |
| `CompressionLevel` | property, read/write | `int get_CompressionLevel(void); void put_CompressionLevel(int newVal);` |
| `CompressionMethod` | property, read/write | `int get_CompressionMethod(void); void put_CompressionMethod(int newVal);` |
| `Crc` | property, read-only | `int get_Crc(void);` |
| `EncryptionKeyLen` | property, read-only | `int get_EncryptionKeyLen(void);` |
| `EntryID` | property, read-only | `int get_EntryID(void);` |
| `EntryType` | property, read-only | `int get_EntryType(void);` |
| `FileDateTimeStr` | property, read/write | `void get_FileDateTimeStr(CkString &str); const wchar_t *fileDateTimeStr(void); void put_FileDateTimeStr(const wchar_t *str);` |
| `FileName` | property, read/write | `void get_FileName(CkString &str); const wchar_t *fileName(void); void put_FileName(const wchar_t *str);` |
| `FileNameHex` | property, read-only | `void get_FileNameHex(CkString &str); const wchar_t *fileNameHex(void);` |
| `HeartbeatMs` | property, read/write | `int get_HeartbeatMs(void); void put_HeartbeatMs(int newVal);` |
| `IsAesEncrypted` | property, read-only | `bool get_IsAesEncrypted(void);` |
| `IsDirectory` | property, read-only | `bool get_IsDirectory(void);` |
| `TextFlag` | property, read/write | `bool get_TextFlag(void); void put_TextFlag(bool newVal);` |
| `UncompressedLength` | property, read-only | `unsigned long get_UncompressedLength(void);` |
| `UncompressedLength64` | property, read-only | `__int64 get_UncompressedLength64(void);` |
| `UncompressedLengthStr` | property, read-only | `void get_UncompressedLengthStr(CkString &str); const wchar_t *uncompressedLengthStr(void);` |
| `AppendString` | method | `bool AppendString(const wchar_t *strContent, const wchar_t *charset);` |
| `CopyToBase64` | method | `bool CopyToBase64(CkString &outStr); const wchar_t *copyToBase64(void);` |
| `CopyToHex` | method | `bool CopyToHex(CkString &outStr); const wchar_t *copyToHex(void);` |
| `Extract` | method | `bool Extract(const wchar_t *dirPath);` |
| `ExtractInto` | method | `bool ExtractInto(const wchar_t *dirPath);` |
| `GetNext` | method | `bool GetNext(void);` |
| `GetNextMatch` | method | `bool GetNextMatch(const wchar_t *pattern);` |
| `LoadTaskCaller` | method | `bool LoadTaskCaller(CkTaskW &task);` |
| `ReplaceString` | method | `bool ReplaceString(const wchar_t *strContent, const wchar_t *charset);` |
| `SetDt` | method | `void SetDt(CkDateTimeW &dt);` |
| `UnzipToBd` | method | `bool UnzipToBd(CkBinDataW &binData);` |
| `UnzipToSb` | method | `bool UnzipToSb(int lineEndingBehavior, const wchar_t *srcCharset, CkStringBuilderW &sb);` |
| `UnzipToStream` | method | `bool UnzipToStream(CkStreamW &toStream);` |
| `UnzipToString` | method | `bool UnzipToString(int lineEndingBehavior, const wchar_t *srcCharset, CkString &outStr); const wchar_t *unzipToString(int lineEndingBehavior, const wchar_t *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 · wcpp · ZipEntry · Comment · property · read/write`

```cpp
void get_Comment(CkString &str);

const wchar_t *comment(void);

void put_Comment(const wchar_t *str);
```

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

### ZipEntry.CompressedLength

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

```cpp
unsigned long get_CompressedLength(void);
```

The compressed size of this entry, in bytes.

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

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

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

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

### ZipEntry.CompressedLength64

`Chilkat 11.7.0 · wcpp · ZipEntry · CompressedLength64 · property · read-only`

```cpp
__int64 get_CompressedLength64(void);
```

The compressed size of this entry, in bytes, as a 64-bit integer.

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

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

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

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

Use this property when sizes may exceed the range of a 32-bit integer.

### ZipEntry.CompressedLengthStr

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

```cpp
void get_CompressedLengthStr(CkString &str);

const wchar_t *compressedLengthStr(void);
```

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 · wcpp · ZipEntry · CompressionLevel · property · read/write`

```cpp
int get_CompressionLevel(void);

void put_CompressionLevel(int newVal);
```

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 · wcpp · ZipEntry · CompressionMethod · property · read/write`

```cpp
int get_CompressionMethod(void);

void put_CompressionMethod(int newVal);
```

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 · wcpp · ZipEntry · Crc · property · read-only`

```cpp
int get_Crc(void);
```

The CRC value for this ZIP entry.

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

### ZipEntry.EncryptionKeyLen

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

```cpp
int get_EncryptionKeyLen(void);
```

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 · wcpp · ZipEntry · EntryID · property · read-only`

```cpp
int get_EntryID(void);
```

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 · wcpp · ZipEntry · EntryType · property · read-only`

```cpp
int get_EntryType(void);
```

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 · wcpp · ZipEntry · FileDateTimeStr · property · read/write`

```cpp
void get_FileDateTimeStr(CkString &str);

const wchar_t *fileDateTimeStr(void);

void put_FileDateTimeStr(const wchar_t *str);
```

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 · wcpp · ZipEntry · FileName · property · read/write`

```cpp
void get_FileName(CkString &str);

const wchar_t *fileName(void);

void put_FileName(const wchar_t *str);
```

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 · wcpp · ZipEntry · FileNameHex · property · read-only`

```cpp
void get_FileNameHex(CkString &str);

const wchar_t *fileNameHex(void);
```

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

This can be useful for diagnosing filename encoding issues.

### ZipEntry.HeartbeatMs

`Chilkat 11.7.0 · wcpp · ZipEntry · HeartbeatMs · property · read/write`

```cpp
int get_HeartbeatMs(void);

void put_HeartbeatMs(int newVal);
```

**Full documentation for this property (same in every language):** [Event Callback Examples](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/event_callback_examples.md)

The interval in milliseconds between each `AbortCheck` event callback, which enables an application to abort certain method calls before they complete. **By default, HeartbeatMs is set to** `0`**, meaning no AbortCheck event callbacks will trigger.**

### ZipEntry.IsAesEncrypted

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

```cpp
bool get_IsAesEncrypted(void);
```

Indicates whether this ZIP entry is AES encrypted.

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

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

### ZipEntry.IsDirectory

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

```cpp
bool get_IsDirectory(void);
```

Indicates whether this ZIP entry is a directory entry.

The value is `true` if the entry represents a directory, and `false` if it represents a file.

### ZipEntry.TextFlag

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

```cpp
bool get_TextFlag(void);

void put_TextFlag(bool newVal);
```

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 · wcpp · ZipEntry · UncompressedLength · property · read-only`

```cpp
unsigned long get_UncompressedLength(void);
```

The uncompressed size of this entry, in bytes.

### ZipEntry.UncompressedLength64

`Chilkat 11.7.0 · wcpp · ZipEntry · UncompressedLength64 · property · read-only`

```cpp
__int64 get_UncompressedLength64(void);
```

The uncompressed size of this entry, in bytes, as a 64-bit integer.

Use this property when the uncompressed size may exceed the range of a 32-bit integer.

### ZipEntry.UncompressedLengthStr

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

```cpp
void get_UncompressedLengthStr(CkString &str);

const wchar_t *uncompressedLengthStr(void);
```

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

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

## Methods

### ZipEntry.AppendString

`Chilkat 11.7.0 · wcpp · ZipEntry · AppendString · method`

```cpp
bool AppendString(const wchar_t *strContent, const wchar_t *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 true for success, false for failure.

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

### ZipEntry.CopyToBase64

`Chilkat 11.7.0 · wcpp · ZipEntry · CopyToBase64 · method`

```cpp
bool CopyToBase64(CkString &outStr);

const wchar_t *copyToBase64(void);
```

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

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

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

Returns true for success, false for failure.

### ZipEntry.CopyToHex

`Chilkat 11.7.0 · wcpp · ZipEntry · CopyToHex · method`

```cpp
bool CopyToHex(CkString &outStr);

const wchar_t *copyToHex(void);
```

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

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

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

Returns true for success, false for failure.

### ZipEntry.Extract

`Chilkat 11.7.0 · wcpp · ZipEntry · Extract · method`

```cpp
bool Extract(const wchar_t *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 true for success, false for failure.

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

### ZipEntry.ExtractInto

`Chilkat 11.7.0 · wcpp · ZipEntry · ExtractInto · method`

```cpp
bool ExtractInto(const wchar_t *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 true for success, false for failure.

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

### ZipEntry.GetNext

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

```cpp
bool GetNext(void);
```

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

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

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

### ZipEntry.GetNextMatch

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

```cpp
bool GetNextMatch(const wchar_t *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 `true` if a matching entry is found. Returns `false` if no further matching entry exists.

### ZipEntry.LoadTaskCaller

`Chilkat 11.7.0 · wcpp · ZipEntry · LoadTaskCaller · method · since 9.5.0.80`

```cpp
bool LoadTaskCaller(CkTaskW &task);
```

Loads the caller of the task's async method.

Returns true for success, false for failure.

### ZipEntry.ReplaceString

`Chilkat 11.7.0 · wcpp · ZipEntry · ReplaceString · method`

```cpp
bool ReplaceString(const wchar_t *strContent, const wchar_t *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 true for success, false for failure.

### ZipEntry.SetDt

`Chilkat 11.7.0 · wcpp · ZipEntry · SetDt · method`

```cpp
void SetDt(CkDateTimeW &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 · wcpp · ZipEntry · UnzipToBd · method · since 9.5.0.67`

```cpp
bool UnzipToBd(CkBinDataW &binData);
```

Unzips this entry directly into a `BinData` object.

The uncompressed bytes are written to `binData`.

Returns true for success, false for failure.

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

### ZipEntry.UnzipToSb

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

```cpp
bool UnzipToSb(int lineEndingBehavior, const wchar_t *srcCharset, CkStringBuilderW &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 true for success, false for failure.

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

### ZipEntry.UnzipToStream

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

```cpp
bool UnzipToStream(CkStreamW &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 true for success, false for failure.

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

### ZipEntry.UnzipToString

`Chilkat 11.7.0 · wcpp · ZipEntry · UnzipToString · method`

```cpp
bool UnzipToString(int lineEndingBehavior, const wchar_t *srcCharset, CkString &outStr);

const wchar_t *unzipToString(int lineEndingBehavior, const wchar_t *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 true for success, false for failure.

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

## Events and callbacks

To receive events, define your own class that inherits from CkBaseProgressW and override just the methods you want to handle. The base class provides an empty implementation of every method, so anything you don't override is simply ignored.

Then create an instance of your class and pass its address to the object's put_EventCallbackObject method. From that point on, the object calls your methods as the work proceeds. Be sure the callback object stays in scope for as long as it is in use.

**For example:**

```cpp
  CkZipEntryW zipentry;

  MyZipEntryProgressW callbackObj;

  zipentry.put_EventCallbackObject(&callbackObj);
```

**MyZipEntryProgressW example:**

```cpp
#include "CkBaseProgressW.h"

class MyZipEntryProgressW : public CkBaseProgressW {

  public:
    MyZipEntryProgressW();
    virtual ~MyZipEntryProgressW();

    void AbortCheck(bool  *abort);
    void PercentDone(int pctDone, bool  *abort);
    void ProgressInfo(const wchar_t *name, const wchar_t *value);
    void TaskCompleted(CkTaskW &task);
};
```

### ZipEntry.AbortCheck (event)

`Chilkat 11.7.0 · wcpp · ZipEntry · AbortCheck · event`

```cpp
void AbortCheck(bool  *abort);
```

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

### ZipEntry.PercentDone (event)

`Chilkat 11.7.0 · wcpp · ZipEntry · PercentDone · event`

```cpp
void PercentDone(int pctDone, bool  *abort);
```

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the `abort` output argument to `true`. This will cause the method to terminate and return a failure status or corresponding failure value.

### ZipEntry.ProgressInfo (event)

`Chilkat 11.7.0 · wcpp · ZipEntry · ProgressInfo · event`

```cpp
void ProgressInfo(const wchar_t *name, const wchar_t *value);
```

This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

### ZipEntry.TaskCompleted (event)

`Chilkat 11.7.0 · wcpp · ZipEntry · TaskCompleted · event`

```cpp
void TaskCompleted(CkTaskW &task);
```

Called from the background thread when an asynchronous task completes.

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

```cpp
CkTaskW *AppendStringAsync(const wchar_t *strContent, const wchar_t *charset);
CkTaskW *ExtractAsync(const wchar_t *dirPath);
CkTaskW *ExtractIntoAsync(const wchar_t *dirPath);
CkTaskW *UnzipToBdAsync(CkBinDataW &binData);
CkTaskW *UnzipToSbAsync(int lineEndingBehavior, const wchar_t *srcCharset, CkStringBuilderW &sb);
CkTaskW *UnzipToStreamAsync(CkStreamW &toStream);
CkTaskW *UnzipToStringAsync(int lineEndingBehavior, const wchar_t *srcCharset);
```

## Deprecated members — do not use in new code

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

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wcpp/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wcpp/classes/CkDateTime.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wcpp/classes/Stream.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wcpp/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wcpp/classes/Task.md)