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

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

**Create/Dispose**

```c
HCkZipEntryW instance = CkZipEntryW_Create();
// ...
CkZipEntryW_Dispose(instance);
```

`HCkZipEntryW CkZipEntryW_Create(void);`

Creates an instance of the HCkZipEntryW object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkZipEntryW_Dispose(HCkZipEntryW handle);`

Objects created by calling CkZipEntryW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkZipEntryW_Dispose.

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.

## 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 CkZipEntryW_getDebugLogFilePath(HCkZipEntryW cHandle, HCkString retval); void CkZipEntryW_putDebugLogFilePath(HCkZipEntryW cHandle, const wchar_t *newVal); const wchar_t *CkZipEntryW_debugLogFilePath(HCkZipEntryW cHandle);` | 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 CkZipEntryW_getLastErrorHtml(HCkZipEntryW cHandle, HCkString retval); const wchar_t *CkZipEntryW_lastErrorHtml(HCkZipEntryW cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkZipEntryW_getLastErrorText(HCkZipEntryW cHandle, HCkString retval); const wchar_t *CkZipEntryW_lastErrorText(HCkZipEntryW cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkZipEntryW_getLastErrorXml(HCkZipEntryW cHandle, HCkString retval); const wchar_t *CkZipEntryW_lastErrorXml(HCkZipEntryW cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkZipEntryW_getLastMethodSuccess(HCkZipEntryW cHandle); void CkZipEntryW_putLastMethodSuccess(HCkZipEntryW cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `VerboseLogging` | `BOOL CkZipEntryW_getVerboseLogging(HCkZipEntryW cHandle); void CkZipEntryW_putVerboseLogging(HCkZipEntryW cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkZipEntryW_getVersion(HCkZipEntryW cHandle, HCkString retval); const wchar_t *CkZipEntryW_version(HCkZipEntryW cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Comment` | property, read/write | `void CkZipEntryW_getComment(HCkZipEntryW cHandle, HCkString retval); void CkZipEntryW_putComment(HCkZipEntryW cHandle, const wchar_t *newVal); const wchar_t *CkZipEntryW_comment(HCkZipEntryW cHandle);` |
| `CompressedLength` | property, read-only | `unsigned long CkZipEntryW_getCompressedLength(HCkZipEntryW cHandle);` |
| `CompressedLength64` | property, read-only | `__int64 CkZipEntryW_getCompressedLength64(HCkZipEntryW cHandle);` |
| `CompressedLengthStr` | property, read-only | `void CkZipEntryW_getCompressedLengthStr(HCkZipEntryW cHandle, HCkString retval); const wchar_t *CkZipEntryW_compressedLengthStr(HCkZipEntryW cHandle);` |
| `CompressionLevel` | property, read/write | `int CkZipEntryW_getCompressionLevel(HCkZipEntryW cHandle); void CkZipEntryW_putCompressionLevel(HCkZipEntryW cHandle, int newVal);` |
| `CompressionMethod` | property, read/write | `int CkZipEntryW_getCompressionMethod(HCkZipEntryW cHandle); void CkZipEntryW_putCompressionMethod(HCkZipEntryW cHandle, int newVal);` |
| `Crc` | property, read-only | `int CkZipEntryW_getCrc(HCkZipEntryW cHandle);` |
| `EncryptionKeyLen` | property, read-only | `int CkZipEntryW_getEncryptionKeyLen(HCkZipEntryW cHandle);` |
| `EntryID` | property, read-only | `int CkZipEntryW_getEntryID(HCkZipEntryW cHandle);` |
| `EntryType` | property, read-only | `int CkZipEntryW_getEntryType(HCkZipEntryW cHandle);` |
| `FileDateTimeStr` | property, read/write | `void CkZipEntryW_getFileDateTimeStr(HCkZipEntryW cHandle, HCkString retval); void CkZipEntryW_putFileDateTimeStr(HCkZipEntryW cHandle, const wchar_t *newVal); const wchar_t *CkZipEntryW_fileDateTimeStr(HCkZipEntryW cHandle);` |
| `FileName` | property, read/write | `void CkZipEntryW_getFileName(HCkZipEntryW cHandle, HCkString retval); void CkZipEntryW_putFileName(HCkZipEntryW cHandle, const wchar_t *newVal); const wchar_t *CkZipEntryW_fileName(HCkZipEntryW cHandle);` |
| `FileNameHex` | property, read-only | `void CkZipEntryW_getFileNameHex(HCkZipEntryW cHandle, HCkString retval); const wchar_t *CkZipEntryW_fileNameHex(HCkZipEntryW cHandle);` |
| `HeartbeatMs` | property, read/write | `int CkZipEntryW_getHeartbeatMs(HCkZipEntryW cHandle); void CkZipEntryW_putHeartbeatMs(HCkZipEntryW cHandle, int newVal);` |
| `IsAesEncrypted` | property, read-only | `BOOL CkZipEntryW_getIsAesEncrypted(HCkZipEntryW cHandle);` |
| `IsDirectory` | property, read-only | `BOOL CkZipEntryW_getIsDirectory(HCkZipEntryW cHandle);` |
| `TextFlag` | property, read/write | `BOOL CkZipEntryW_getTextFlag(HCkZipEntryW cHandle); void CkZipEntryW_putTextFlag(HCkZipEntryW cHandle, BOOL newVal);` |
| `UncompressedLength` | property, read-only | `unsigned long CkZipEntryW_getUncompressedLength(HCkZipEntryW cHandle);` |
| `UncompressedLength64` | property, read-only | `__int64 CkZipEntryW_getUncompressedLength64(HCkZipEntryW cHandle);` |
| `UncompressedLengthStr` | property, read-only | `void CkZipEntryW_getUncompressedLengthStr(HCkZipEntryW cHandle, HCkString retval); const wchar_t *CkZipEntryW_uncompressedLengthStr(HCkZipEntryW cHandle);` |
| `AppendString` | method | `BOOL CkZipEntryW_AppendString(HCkZipEntryW cHandle, const wchar_t *strContent, const wchar_t *charset);` |
| `CopyToBase64` | method | `BOOL CkZipEntryW_CopyToBase64(HCkZipEntryW cHandle, const wchar_t *outStr); const wchar_t *CkZipEntryW_copyToBase64(HCkZipEntryW cHandle);` |
| `CopyToHex` | method | `BOOL CkZipEntryW_CopyToHex(HCkZipEntryW cHandle, const wchar_t *outStr); const wchar_t *CkZipEntryW_copyToHex(HCkZipEntryW cHandle);` |
| `Extract` | method | `BOOL CkZipEntryW_Extract(HCkZipEntryW cHandle, const wchar_t *dirPath);` |
| `ExtractInto` | method | `BOOL CkZipEntryW_ExtractInto(HCkZipEntryW cHandle, const wchar_t *dirPath);` |
| `GetNext` | method | `BOOL CkZipEntryW_GetNext(HCkZipEntryW cHandle);` |
| `GetNextMatch` | method | `BOOL CkZipEntryW_GetNextMatch(HCkZipEntryW cHandle, const wchar_t *pattern);` |
| `LoadTaskCaller` | method | `BOOL CkZipEntryW_LoadTaskCaller(HCkZipEntryW cHandle, HCkTaskW task);` |
| `ReplaceString` | method | `BOOL CkZipEntryW_ReplaceString(HCkZipEntryW cHandle, const wchar_t *strContent, const wchar_t *charset);` |
| `SetDt` | method | `void CkZipEntryW_SetDt(HCkZipEntryW cHandle, HCkDateTimeW dt);` |
| `UnzipToBd` | method | `BOOL CkZipEntryW_UnzipToBd(HCkZipEntryW cHandle, HCkBinDataW binData);` |
| `UnzipToSb` | method | `BOOL CkZipEntryW_UnzipToSb(HCkZipEntryW cHandle, int lineEndingBehavior, const wchar_t *srcCharset, HCkStringBuilderW sb);` |
| `UnzipToStream` | method | `BOOL CkZipEntryW_UnzipToStream(HCkZipEntryW cHandle, HCkStreamW toStream);` |
| `UnzipToString` | method | `BOOL CkZipEntryW_UnzipToString(HCkZipEntryW cHandle, int lineEndingBehavior, const wchar_t *srcCharset, const wchar_t *outStr); const wchar_t *CkZipEntryW_unzipToString(HCkZipEntryW cHandle, 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 · wc · ZipEntry · Comment · property · read/write`

```c
void CkZipEntryW_getComment(HCkZipEntryW cHandle, HCkString retval);
void CkZipEntryW_putComment(HCkZipEntryW cHandle, const wchar_t *newVal);
const wchar_t *CkZipEntryW_comment(HCkZipEntryW cHandle);
```

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

### ZipEntry.CompressedLength

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

```c
unsigned long CkZipEntryW_getCompressedLength(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · CompressedLength64 · property · read-only`

```c
__int64 CkZipEntryW_getCompressedLength64(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · CompressedLengthStr · property · read-only`

```c
void CkZipEntryW_getCompressedLengthStr(HCkZipEntryW cHandle, HCkString retval);
const wchar_t *CkZipEntryW_compressedLengthStr(HCkZipEntryW cHandle);
```

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

```c
int CkZipEntryW_getCompressionLevel(HCkZipEntryW cHandle);
void CkZipEntryW_putCompressionLevel(HCkZipEntryW cHandle, 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 · wc · ZipEntry · CompressionMethod · property · read/write`

```c
int CkZipEntryW_getCompressionMethod(HCkZipEntryW cHandle);
void CkZipEntryW_putCompressionMethod(HCkZipEntryW cHandle, 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 · wc · ZipEntry · Crc · property · read-only`

```c
int CkZipEntryW_getCrc(HCkZipEntryW cHandle);
```

The CRC value for this ZIP entry.

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

### ZipEntry.EncryptionKeyLen

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

```c
int CkZipEntryW_getEncryptionKeyLen(HCkZipEntryW cHandle);
```

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

```c
int CkZipEntryW_getEntryID(HCkZipEntryW cHandle);
```

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

```c
int CkZipEntryW_getEntryType(HCkZipEntryW cHandle);
```

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

```c
void CkZipEntryW_getFileDateTimeStr(HCkZipEntryW cHandle, HCkString retval);
void CkZipEntryW_putFileDateTimeStr(HCkZipEntryW cHandle, const wchar_t *newVal);
const wchar_t *CkZipEntryW_fileDateTimeStr(HCkZipEntryW cHandle);
```

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

```c
void CkZipEntryW_getFileName(HCkZipEntryW cHandle, HCkString retval);
void CkZipEntryW_putFileName(HCkZipEntryW cHandle, const wchar_t *newVal);
const wchar_t *CkZipEntryW_fileName(HCkZipEntryW cHandle);
```

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

```c
void CkZipEntryW_getFileNameHex(HCkZipEntryW cHandle, HCkString retval);
const wchar_t *CkZipEntryW_fileNameHex(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · HeartbeatMs · property · read/write`

```c
int CkZipEntryW_getHeartbeatMs(HCkZipEntryW cHandle);
void CkZipEntryW_putHeartbeatMs(HCkZipEntryW cHandle, 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 · wc · ZipEntry · IsAesEncrypted · property · read-only · since 9.5.0.69`

```c
BOOL CkZipEntryW_getIsAesEncrypted(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · IsDirectory · property · read-only`

```c
BOOL CkZipEntryW_getIsDirectory(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · TextFlag · property · read/write`

```c
BOOL CkZipEntryW_getTextFlag(HCkZipEntryW cHandle);
void CkZipEntryW_putTextFlag(HCkZipEntryW cHandle, 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 · wc · ZipEntry · UncompressedLength · property · read-only`

```c
unsigned long CkZipEntryW_getUncompressedLength(HCkZipEntryW cHandle);
```

The uncompressed size of this entry, in bytes.

### ZipEntry.UncompressedLength64

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

```c
__int64 CkZipEntryW_getUncompressedLength64(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · UncompressedLengthStr · property · read-only`

```c
void CkZipEntryW_getUncompressedLengthStr(HCkZipEntryW cHandle, HCkString retval);
const wchar_t *CkZipEntryW_uncompressedLengthStr(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · AppendString · method`

```c
BOOL CkZipEntryW_AppendString(HCkZipEntryW cHandle, 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 · wc · ZipEntry · CopyToBase64 · method`

```c
BOOL CkZipEntryW_CopyToBase64(HCkZipEntryW cHandle, const wchar_t *outStr);
const wchar_t *CkZipEntryW_copyToBase64(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · CopyToHex · method`

```c
BOOL CkZipEntryW_CopyToHex(HCkZipEntryW cHandle, const wchar_t *outStr);
const wchar_t *CkZipEntryW_copyToHex(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · Extract · method`

```c
BOOL CkZipEntryW_Extract(HCkZipEntryW cHandle, 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 · wc · ZipEntry · ExtractInto · method`

```c
BOOL CkZipEntryW_ExtractInto(HCkZipEntryW cHandle, 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 · wc · ZipEntry · GetNext · method · since 11.0.0`

```c
BOOL CkZipEntryW_GetNext(HCkZipEntryW cHandle);
```

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 · wc · ZipEntry · GetNextMatch · method · since 11.0.0`

```c
BOOL CkZipEntryW_GetNextMatch(HCkZipEntryW cHandle, 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 · wc · ZipEntry · LoadTaskCaller · method · since 9.5.0.80`

```c
BOOL CkZipEntryW_LoadTaskCaller(HCkZipEntryW cHandle, HCkTaskW task);
```

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

### ZipEntry.ReplaceString

`Chilkat 11.7.0 · wc · ZipEntry · ReplaceString · method`

```c
BOOL CkZipEntryW_ReplaceString(HCkZipEntryW cHandle, 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 · wc · ZipEntry · SetDt · method`

```c
void CkZipEntryW_SetDt(HCkZipEntryW cHandle, HCkDateTimeW 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 · wc · ZipEntry · UnzipToBd · method · since 9.5.0.67`

```c
BOOL CkZipEntryW_UnzipToBd(HCkZipEntryW cHandle, HCkBinDataW 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 · wc · ZipEntry · UnzipToSb · method · since 9.5.0.67`

```c
BOOL CkZipEntryW_UnzipToSb(HCkZipEntryW cHandle, int lineEndingBehavior, const wchar_t *srcCharset, HCkStringBuilderW 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 · wc · ZipEntry · UnzipToStream · method · since 9.5.0.67`

```c
BOOL CkZipEntryW_UnzipToStream(HCkZipEntryW cHandle, HCkStreamW 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 · wc · ZipEntry · UnzipToString · method`

```c
BOOL CkZipEntryW_UnzipToString(HCkZipEntryW cHandle, int lineEndingBehavior, const wchar_t *srcCharset, const wchar_t *outStr);
const wchar_t *CkZipEntryW_unzipToString(HCkZipEntryW cHandle, 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

This binding delivers progress information through callbacks (AbortCheck, PercentDone, ProgressInfo, TaskCompleted) rather than events. See `guide.md` for how to attach them in Unicode C.

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

```c
HCkTaskW CkZipEntryW_AppendStringAsync(HCkZipEntryW cHandle, const wchar_t *strContent, const wchar_t *charset);
HCkTaskW CkZipEntryW_ExtractAsync(HCkZipEntryW cHandle, const wchar_t *dirPath);
HCkTaskW CkZipEntryW_ExtractIntoAsync(HCkZipEntryW cHandle, const wchar_t *dirPath);
HCkTaskW CkZipEntryW_UnzipToBdAsync(HCkZipEntryW cHandle, HCkBinDataW binData);
HCkTaskW CkZipEntryW_UnzipToSbAsync(HCkZipEntryW cHandle, int lineEndingBehavior, const wchar_t *srcCharset, HCkStringBuilderW sb);
HCkTaskW CkZipEntryW_UnzipToStreamAsync(HCkZipEntryW cHandle, HCkStreamW toStream);
HCkTaskW CkZipEntryW_UnzipToStringAsync(HCkZipEntryW cHandle, 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/wc/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/classes/CkDateTime.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/classes/Stream.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/classes/Task.md)

