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

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

```csharp
Chilkat.ZipEntry obj = new Chilkat.ZipEntry();
```

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

Minimal complete program:

```csharp
// Required once per process. Any string unlocks a 30-day trial; use your purchased code in production.
Chilkat.Global glob = new Chilkat.Global();
if (!glob.UnlockBundle("Anything for 30-day trial"))
{
    Console.WriteLine(glob.LastErrorText);
    return;
}

Chilkat.ZipEntry zipEntry = new Chilkat.ZipEntry();

bool success = zipEntry.AppendString("<strContent>", "<charset>");
if (!success)
{
    Console.WriteLine(zipEntry.LastErrorText);   // full diagnostic of what went wrong
    return;
}
```

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` | `public string DebugLogFilePath {get; set; }` | 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` | `public string LastErrorHtml {get; }` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `public string LastErrorText {get; }` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `public string LastErrorXml {get; }` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `public bool LastMethodSuccess {get; set; }` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `public bool VerboseLogging {get; set; }` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `public string Version {get; }` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Comment` | property, read/write | `public string Comment {get; set; }` |
| `CompressedLength` | property, read-only | `public uint CompressedLength {get; }` |
| `CompressedLength64` | property, read-only | `public long CompressedLength64 {get; }` |
| `CompressedLengthStr` | property, read-only | `public string CompressedLengthStr {get; }` |
| `CompressionLevel` | property, read/write | `public int CompressionLevel {get; set; }` |
| `CompressionMethod` | property, read/write | `public int CompressionMethod {get; set; }` |
| `Crc` | property, read-only | `public int Crc {get; }` |
| `EncryptionKeyLen` | property, read-only | `public int EncryptionKeyLen {get; }` |
| `EntryID` | property, read-only | `public int EntryID {get; }` |
| `EntryType` | property, read-only | `public int EntryType {get; }` |
| `FileDateTime` | property, read/write | `public DateTime FileDateTime {get; set; }` |
| `FileDateTimeStr` | property, read/write | `public string FileDateTimeStr {get; set; }` |
| `FileName` | property, read/write | `public string FileName {get; set; }` |
| `FileNameHex` | property, read-only | `public string FileNameHex {get; }` |
| `HeartbeatMs` | property, read/write | `public int HeartbeatMs {get; set; }` |
| `IsAesEncrypted` | property, read-only | `public bool IsAesEncrypted {get; }` |
| `IsDirectory` | property, read-only | `public bool IsDirectory {get; }` |
| `TextFlag` | property, read/write | `public bool TextFlag {get; set; }` |
| `UncompressedLength` | property, read-only | `public uint UncompressedLength {get; }` |
| `UncompressedLength64` | property, read-only | `public long UncompressedLength64 {get; }` |
| `UncompressedLengthStr` | property, read-only | `public string UncompressedLengthStr {get; }` |
| `AppendData` | method | `public bool AppendData(byte[] inData);` |
| `AppendString` | method | `public bool AppendString(string strContent, string charset);` |
| `Copy` | method | `public byte[] Copy();` |
| `CopyToBase64` | method | `public string CopyToBase64();` |
| `CopyToHex` | method | `public string CopyToHex();` |
| `Extract` | method | `public bool Extract(string dirPath);` |
| `ExtractInto` | method | `public bool ExtractInto(string dirPath);` |
| `GetNext` | method | `public bool GetNext();` |
| `GetNextMatch` | method | `public bool GetNextMatch(string pattern);` |
| `Inflate` | method | `public byte[] Inflate();` |
| `LoadTaskCaller` | method | `public bool LoadTaskCaller(Task task);` |
| `ReplaceData` | method | `public bool ReplaceData(byte[] inData);` |
| `ReplaceString` | method | `public bool ReplaceString(string strContent, string charset);` |
| `SetDt` | method | `public void SetDt(CkDateTime dt);` |
| `UnzipToBd` | method | `public bool UnzipToBd(BinData binData);` |
| `UnzipToSb` | method | `public bool UnzipToSb(int lineEndingBehavior, string srcCharset, StringBuilder sb);` |
| `UnzipToStream` | method | `public bool UnzipToStream(Stream toStream);` |
| `UnzipToString` | method | `public string UnzipToString(int 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 · csharp · ZipEntry · Comment · property · read/write`

```csharp
public string Comment {get; set; }
```

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

### ZipEntry.CompressedLength

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

```csharp
public uint CompressedLength {get; }
```

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

```csharp
public long CompressedLength64 {get; }
```

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

```csharp
public string CompressedLengthStr {get; }
```

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

```csharp
public int CompressionLevel {get; set; }
```

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

```csharp
public int CompressionMethod {get; set; }
```

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

```csharp
public int Crc {get; }
```

The CRC value for this ZIP entry.

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

### ZipEntry.EncryptionKeyLen

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

```csharp
public int EncryptionKeyLen {get; }
```

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

```csharp
public int EntryID {get; }
```

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

```csharp
public int EntryType {get; }
```

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

`Chilkat 11.7.0 · csharp · ZipEntry · FileDateTime · property · read/write`

```csharp
public DateTime FileDateTime {get; set; }
```

Gets or sets the last-modified date/time for this ZIP entry.

### ZipEntry.FileDateTimeStr

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

```csharp
public string FileDateTimeStr {get; set; }
```

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

```csharp
public string FileName {get; set; }
```

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

```csharp
public string FileNameHex {get; }
```

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

```csharp
public int HeartbeatMs {get; set; }
```

**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 · csharp · ZipEntry · IsAesEncrypted · property · read-only · since 9.5.0.69`

```csharp
public bool IsAesEncrypted {get; }
```

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

```csharp
public bool IsDirectory {get; }
```

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

```csharp
public bool TextFlag {get; set; }
```

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

```csharp
public uint UncompressedLength {get; }
```

The uncompressed size of this entry, in bytes.

### ZipEntry.UncompressedLength64

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

```csharp
public long UncompressedLength64 {get; }
```

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

```csharp
public string UncompressedLengthStr {get; }
```

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 · csharp · ZipEntry · AppendData · method`

```csharp
public bool AppendData(byte[] 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 true for success, false for failure.

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

### ZipEntry.AppendString

`Chilkat 11.7.0 · csharp · ZipEntry · AppendString · method`

```csharp
public bool 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 true for success, false for failure.

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

### ZipEntry.Copy

`Chilkat 11.7.0 · csharp · ZipEntry · Copy · method`

```csharp
public byte[] 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 an empty byte array on failure

### ZipEntry.CopyToBase64

`Chilkat 11.7.0 · csharp · ZipEntry · CopyToBase64 · method`

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

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

```csharp
public bool 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 true for success, false for failure.

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

### ZipEntry.ExtractInto

`Chilkat 11.7.0 · csharp · ZipEntry · ExtractInto · method`

```csharp
public bool 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 true for success, false for failure.

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

### ZipEntry.GetNext

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

```csharp
public bool 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 `true` if the object was advanced to the next entry. Returns `false` if there are no more entries.

### ZipEntry.GetNextMatch

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

```csharp
public bool 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 `true` if a matching entry is found. Returns `false` if no further matching entry exists.

### ZipEntry.Inflate

`Chilkat 11.7.0 · csharp · ZipEntry · Inflate · method`

```csharp
public byte[] 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 an empty byte array on failure

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

### ZipEntry.LoadTaskCaller

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

```csharp
public bool LoadTaskCaller(Task task);
```

Loads the caller of the task's async method.

Returns true for success, false for failure.

### ZipEntry.ReplaceData

`Chilkat 11.7.0 · csharp · ZipEntry · ReplaceData · method`

```csharp
public bool ReplaceData(byte[] inData);
```

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

The new data becomes the complete contents of the entry.

Returns true for success, false for failure.

### ZipEntry.ReplaceString

`Chilkat 11.7.0 · csharp · ZipEntry · ReplaceString · method`

```csharp
public bool 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 true for success, false for failure.

### ZipEntry.SetDt

`Chilkat 11.7.0 · csharp · ZipEntry · SetDt · method`

```csharp
public void 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 · csharp · ZipEntry · UnzipToBd · method · since 9.5.0.67`

```csharp
public bool UnzipToBd(BinData 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 · csharp · ZipEntry · UnzipToSb · method · since 9.5.0.67`

```csharp
public bool UnzipToSb(int lineEndingBehavior, string srcCharset, StringBuilder 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 · csharp · ZipEntry · UnzipToStream · method · since 9.5.0.67`

```csharp
public bool UnzipToStream(Stream 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 · csharp · ZipEntry · UnzipToString · method`

```csharp
public string UnzipToString(int 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

### ZipEntry.AbortCheck (event)

`Chilkat 11.7.0 · csharp · ZipEntry · AbortCheck · event`

```csharp
public event AbortCheckEventHandler OnAbortCheck;
```

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.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

**Event callback implementation:**

```csharp
private void zipentry_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
zipentry.OnAbortCheck += zipentry_OnAbortCheck;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handleAbortCheck(out bool abort)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
// ...
Chilkat.ZipEntry.AbortCheck abortCheck = new Chilkat.ZipEntry.AbortCheck(handleAbortCheck);
zipentry.setAbortCheckCb(abortCheck);
```

### ZipEntry.PercentDone (event)

`Chilkat 11.7.0 · csharp · ZipEntry · PercentDone · event`

```csharp
public event PercentDoneEventHandler OnPercentDone;
```

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.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

**Event callback implementation:**

```csharp
private void zipentry_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
zipentry.OnPercentDone += zipentry_OnPercentDone;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handlePercentDone(int pctDone, out bool abort)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
// ...
Chilkat.ZipEntry.PercentDone percentDone = new Chilkat.ZipEntry.PercentDone(handlePercentDone);
zipentry.setPercentDoneCb(percentDone);
```

### ZipEntry.ProgressInfo (event)

`Chilkat 11.7.0 · csharp · ZipEntry · ProgressInfo · event`

```csharp
public event ProgressInfoEventHandler OnProgressInfo;
```

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.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

**Event callback implementation:**

```csharp
private void zipentry_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
zipentry.OnProgressInfo += zipentry_OnProgressInfo;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handleProgressInfo(string name, string value)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
// ...
Chilkat.ZipEntry.ProgressInfo progressInfo = new Chilkat.ZipEntry.ProgressInfo(handleProgressInfo);
zipentry.setProgressInfoCb(progressInfo);
```

### ZipEntry.TaskCompleted (event)

`Chilkat 11.7.0 · csharp · ZipEntry · TaskCompleted · event`

```csharp
public event TaskCompletedEventHandler OnTaskCompleted;
```

Called from the background thread when an asynchronous task completes.

### Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

**Event callback implementation:**

```csharp
private void zipentry_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
zipentry.OnTaskCompleted += zipentry_OnTaskCompleted;
```

### Chilkat .NET Core Event Implementation

**Event callback implementation:**

```csharp
public void handleTaskIdCompleted(int taskId)
	{
	    // application code goes here.
	}
```

**To add an event handler:**

```csharp
Chilkat.ZipEntry zipentry = new Chilkat.ZipEntry();
// ...
Chilkat.ZipEntry.TaskIdCompleted taskIdCompleted = new Chilkat.ZipEntry.TaskIdCompleted(handleTaskIdCompleted);
zipentry.setTaskIdCompletedCb(taskIdCompleted);
```

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

```csharp
public Task AppendDataAsync(byte[] inData);
public Task AppendStringAsync(string strContent, string charset);
public Task ExtractAsync(string dirPath);
public Task ExtractIntoAsync(string dirPath);
public Task InflateAsync();
public Task UnzipToBdAsync(BinData binData);
public Task UnzipToSbAsync(int lineEndingBehavior, string srcCharset, StringBuilder sb);
public Task UnzipToStreamAsync(Stream toStream);
public Task UnzipToStringAsync(int 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/csharp/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/csharp/classes/CkDateTime.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/csharp/classes/Stream.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/csharp/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/csharp/classes/Task.md)

