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

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

## Purpose

**Compress and decompress bytes, text, files, and streams with a flexible API.**

`Chilkat.Compression` provides a general-purpose API for compressing and decompressing data in memory, files, and streams. It supports multiple algorithms, text charset conversion, encoded output, chunked processing, and streaming operations for large data.

**Multiple algorithms**

Supports `deflate`, `zlib`, `bzip2`, and `lzw`.

**Flexible data types**

Work with byte arrays, strings, `BinData`, `StringBuilder`, files, and streams.

**Chunked processing**

Process data incrementally with `FirstChunk` and `LastChunk` for chunk-aware methods.

**Encoded output**

Return compressed bytes as text using encodings such as `base64`, `hex`, and others.

**Streaming support**

Compress or decompress large files and streams with stable memory usage.

**Compression + encryption**

Combine compression and encryption in file workflows with integrated methods.

**Tip:** For text compression, explicitly set `Charset = "utf-8"` unless another encoding is required. For encoded compressed data, set `EncodingMode` to the desired output format.

For an extended overview, see [Compression Class Overview](https://www.chilkatsoft.com/compression_class_overview.asp). See also [Binary Encodings](https://www.chilkatsoft.com/binary_encodings.asp) for supported encoded output formats.

## Object creation, unlocking and error handling

**Create/Dispose**

```c
HCkCompressionW instance = CkCompressionW_Create();
// ...
CkCompressionW_Dispose(instance);
```

`HCkCompressionW CkCompressionW_Create(void);`

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

`void CkCompressionW_Dispose(HCkCompressionW handle);`

Objects created by calling CkCompressionW_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 CkCompressionW_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 CkCompressionW_getDebugLogFilePath(HCkCompressionW cHandle, HCkString retval); void CkCompressionW_putDebugLogFilePath(HCkCompressionW cHandle, const wchar_t *newVal); const wchar_t *CkCompressionW_debugLogFilePath(HCkCompressionW 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 CkCompressionW_getLastErrorHtml(HCkCompressionW cHandle, HCkString retval); const wchar_t *CkCompressionW_lastErrorHtml(HCkCompressionW cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkCompressionW_getLastErrorText(HCkCompressionW cHandle, HCkString retval); const wchar_t *CkCompressionW_lastErrorText(HCkCompressionW cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkCompressionW_getLastErrorXml(HCkCompressionW cHandle, HCkString retval); const wchar_t *CkCompressionW_lastErrorXml(HCkCompressionW cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkCompressionW_getLastMethodSuccess(HCkCompressionW cHandle); void CkCompressionW_putLastMethodSuccess(HCkCompressionW cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `VerboseLogging` | `BOOL CkCompressionW_getVerboseLogging(HCkCompressionW cHandle); void CkCompressionW_putVerboseLogging(HCkCompressionW 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 CkCompressionW_getVersion(HCkCompressionW cHandle, HCkString retval); const wchar_t *CkCompressionW_version(HCkCompressionW cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Algorithm` | property, read/write | `void CkCompressionW_getAlgorithm(HCkCompressionW cHandle, HCkString retval); void CkCompressionW_putAlgorithm(HCkCompressionW cHandle, const wchar_t *newVal); const wchar_t *CkCompressionW_algorithm(HCkCompressionW cHandle);` |
| `Charset` | property, read/write | `void CkCompressionW_getCharset(HCkCompressionW cHandle, HCkString retval); void CkCompressionW_putCharset(HCkCompressionW cHandle, const wchar_t *newVal); const wchar_t *CkCompressionW_charset(HCkCompressionW cHandle);` |
| `DeflateLevel` | property, read/write | `int CkCompressionW_getDeflateLevel(HCkCompressionW cHandle); void CkCompressionW_putDeflateLevel(HCkCompressionW cHandle, int newVal);` |
| `EncodingMode` | property, read/write | `void CkCompressionW_getEncodingMode(HCkCompressionW cHandle, HCkString retval); void CkCompressionW_putEncodingMode(HCkCompressionW cHandle, const wchar_t *newVal); const wchar_t *CkCompressionW_encodingMode(HCkCompressionW cHandle);` |
| `FirstChunk` | property, read/write | `BOOL CkCompressionW_getFirstChunk(HCkCompressionW cHandle); void CkCompressionW_putFirstChunk(HCkCompressionW cHandle, BOOL newVal);` |
| `HeartbeatMs` | property, read/write | `int CkCompressionW_getHeartbeatMs(HCkCompressionW cHandle); void CkCompressionW_putHeartbeatMs(HCkCompressionW cHandle, int newVal);` |
| `LastChunk` | property, read/write | `BOOL CkCompressionW_getLastChunk(HCkCompressionW cHandle); void CkCompressionW_putLastChunk(HCkCompressionW cHandle, BOOL newVal);` |
| `UncommonOptions` | property, read/write | `void CkCompressionW_getUncommonOptions(HCkCompressionW cHandle, HCkString retval); void CkCompressionW_putUncommonOptions(HCkCompressionW cHandle, const wchar_t *newVal); const wchar_t *CkCompressionW_uncommonOptions(HCkCompressionW cHandle);` |
| `CompressBd` | method | `BOOL CkCompressionW_CompressBd(HCkCompressionW cHandle, HCkBinDataW bd);` |
| `CompressBd2` | method | `BOOL CkCompressionW_CompressBd2(HCkCompressionW cHandle, HCkBinDataW bdIn, HCkBinDataW bdOut);` |
| `CompressEncryptFile` | method | `BOOL CkCompressionW_CompressEncryptFile(HCkCompressionW cHandle, HCkJsonObjectW cryptParams, const wchar_t *srcPath, const wchar_t *destPath);` |
| `CompressFile` | method | `BOOL CkCompressionW_CompressFile(HCkCompressionW cHandle, const wchar_t *srcPath, const wchar_t *destPath);` |
| `CompressSb` | method | `BOOL CkCompressionW_CompressSb(HCkCompressionW cHandle, HCkStringBuilderW sb, HCkBinDataW binData);` |
| `CompressStream` | method | `BOOL CkCompressionW_CompressStream(HCkCompressionW cHandle, HCkStreamW strm);` |
| `CompressStringENC` | method | `BOOL CkCompressionW_CompressStringENC(HCkCompressionW cHandle, const wchar_t *str, const wchar_t *outStr); const wchar_t *CkCompressionW_compressStringENC(HCkCompressionW cHandle, const wchar_t *str);` |
| `DecompressBd` | method | `BOOL CkCompressionW_DecompressBd(HCkCompressionW cHandle, HCkBinDataW bd);` |
| `DecompressBd2` | method | `BOOL CkCompressionW_DecompressBd2(HCkCompressionW cHandle, HCkBinDataW bdIn, HCkBinDataW bdOut);` |
| `DecompressFile` | method | `BOOL CkCompressionW_DecompressFile(HCkCompressionW cHandle, const wchar_t *srcPath, const wchar_t *destPath);` |
| `DecompressSb` | method | `BOOL CkCompressionW_DecompressSb(HCkCompressionW cHandle, HCkBinDataW binData, HCkStringBuilderW sb);` |
| `DecompressStream` | method | `BOOL CkCompressionW_DecompressStream(HCkCompressionW cHandle, HCkStreamW strm);` |
| `DecompressStringENC` | method | `BOOL CkCompressionW_DecompressStringENC(HCkCompressionW cHandle, const wchar_t *encodedCompressedData, const wchar_t *outStr); const wchar_t *CkCompressionW_decompressStringENC(HCkCompressionW cHandle, const wchar_t *encodedCompressedData);` |
| `DecryptDecompressFile` | method | `BOOL CkCompressionW_DecryptDecompressFile(HCkCompressionW cHandle, HCkJsonObjectW cryptParams, const wchar_t *srcPath, const wchar_t *destPath);` |
| `LoadTaskCaller` | method | `BOOL CkCompressionW_LoadTaskCaller(HCkCompressionW cHandle, HCkTaskW task);` |

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

## Properties

### Compression.Algorithm

`Chilkat 11.7.0 · wc · Compression · Algorithm · property · read/write`

```c
void CkCompressionW_getAlgorithm(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putAlgorithm(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_algorithm(HCkCompressionW cHandle);
```

Specifies the compression algorithm to use. Supported values are `deflate`, `zlib`, `gzip`, `bzip2`, and `lzw`.

The `zlib` option is the deflate algorithm with a zlib header.

The `gzip` option (starting in v11.7.0) is the deflate algorithm in the gzip format (RFC 1952): a gzip header, the deflate data, and a trailer with the CRC-32 and size of the uncompressed data. When decompressing in one call, the CRC-32 and size are checked. Before v11.7.0, `gzip` was not recognized and was treated as `deflate`.

**Note:** `ppmd` is deprecated and should not be used. It was only available on 32-bit systems and specifically used the J variant. New applications should use one of the supported algorithms listed above.

### Compression.Charset

`Chilkat 11.7.0 · wc · Compression · Charset · property · read/write`

```c
void CkCompressionW_getCharset(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putCharset(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_charset(HCkCompressionW cHandle);
```

**Full documentation for this property (same in every language):** [How Character Encoding (Charset) Affects Compression and Decompression](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/how_charset_affects_compression.md) · [Full List of Character Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.

The current default is the computer’s ANSI charset, such as Windows-1252 on many Western Windows systems. However, most modern applications should explicitly set this property to `utf-8`.

**Recommendation:** Set `Charset = "utf-8"` unless you specifically need compatibility with another encoding.

### Compression.DeflateLevel

`Chilkat 11.7.0 · wc · Compression · DeflateLevel · property · read/write · since 9.5.0.73`

```c
int CkCompressionW_getDeflateLevel(HCkCompressionW cHandle);
void CkCompressionW_putDeflateLevel(HCkCompressionW cHandle, int newVal);
```

Sets the compression level used by the `deflate` and `zlib` algorithms.

- `0` means no compression.
- `9` means maximum compression.
- The default value is `6`.

Higher values may produce smaller output but can require more processing time.

### Compression.EncodingMode

`Chilkat 11.7.0 · wc · Compression · EncodingMode · property · read/write`

```c
void CkCompressionW_getEncodingMode(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putEncodingMode(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_encodingMode(HCkCompressionW cHandle);
```

**Full documentation for this property (same in every language):** [Binary Encodings Supported by Chilkat](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/binary_encodings.md)

Specifies the text encoding used by methods whose names end in `ENC`, such as `CompressBytesENC` and `DecompressStringENC`.

Compression methods ending in `ENC` return compressed binary data as an encoded string. Decompression methods ending in `ENC` expect the input string to use this same encoding.

Valid values include:

- `base64`
- `hex`
- `url`
- `quoted-printable`

### Compression.FirstChunk

`Chilkat 11.7.0 · wc · Compression · FirstChunk · property · read/write · since 11.0.0`

```c
BOOL CkCompressionW_getFirstChunk(HCkCompressionW cHandle);
void CkCompressionW_putFirstChunk(HCkCompressionW cHandle, BOOL newVal);
```

Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.

The default value is `TRUE`.

When both `FirstChunk` and `LastChunk` are `TRUE`, the method call is treated as a complete, single-call compression or decompression operation.

### Compression.HeartbeatMs

`Chilkat 11.7.0 · wc · Compression · HeartbeatMs · property · read/write`

```c
int CkCompressionW_getHeartbeatMs(HCkCompressionW cHandle);
void CkCompressionW_putHeartbeatMs(HCkCompressionW 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)

Specifies the interval, in milliseconds, between `AbortCheck` event callbacks.

This allows an application to periodically check whether a long-running operation should be aborted.

The default value is `0`, which disables `AbortCheck` callbacks.

### Compression.LastChunk

`Chilkat 11.7.0 · wc · Compression · LastChunk · property · read/write · since 11.0.0`

```c
BOOL CkCompressionW_getLastChunk(HCkCompressionW cHandle);
void CkCompressionW_putLastChunk(HCkCompressionW cHandle, BOOL newVal);
```

Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.

The default value is `TRUE`.

When both `FirstChunk` and `LastChunk` are `TRUE`, the input is treated as the complete data set and processed in a single call.

### Compression.UncommonOptions

`Chilkat 11.7.0 · wc · Compression · UncommonOptions · property · read/write · since 11.0.0`

```c
void CkCompressionW_getUncommonOptions(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putUncommonOptions(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_uncommonOptions(HCkCompressionW cHandle);
```

Provides a way to enable specialized or uncommon behavior. This property normally remains empty.

It may be set to a comma-separated list of keywords.

Supported option:

- `Crypt2CompressHdr` — Duplicates the compression/decompression header behavior used by the deprecated and removed Crypt2 compression functions.

## Methods

### Compression.CompressBd

`Chilkat 11.7.0 · wc · Compression · CompressBd · method · since 9.5.0.66`

```c
BOOL CkCompressionW_CompressBd(HCkCompressionW cHandle, HCkBinDataW bd);
```

Compresses the data contained in a `BinData` object.

The `BinData` object is modified to contain the compressed result.

This method is not `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.CompressBd2

`Chilkat 11.7.0 · wc · Compression · CompressBd2 · method · since 11.0.0`

```c
BOOL CkCompressionW_CompressBd2(HCkCompressionW cHandle, HCkBinDataW bdIn, HCkBinDataW bdOut);
```

Compresses the data in one `BinData` object and appends the compressed output to another `BinData` object.

The input `BinData` is not modified.

This method is `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.CompressEncryptFile

`Chilkat 11.7.0 · wc · Compression · CompressEncryptFile · method · since 9.5.0.99`

```c
BOOL CkCompressionW_CompressEncryptFile(HCkCompressionW cHandle, HCkJsonObjectW cryptParams, const wchar_t *srcPath, const wchar_t *destPath);
```

Compresses and encrypts a file, writing the result to a destination file.

The compression and encryption are performed internally in streaming mode, so files of any size can be processed without loading the entire file into memory.

Returns TRUE for success, FALSE for failure.

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

### Compression.CompressFile

`Chilkat 11.7.0 · wc · Compression · CompressFile · method`

```c
BOOL CkCompressionW_CompressFile(HCkCompressionW cHandle, const wchar_t *srcPath, const wchar_t *destPath);
```

Compresses a source file and writes the compressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be compressed with stable memory usage.

Returns TRUE for success, FALSE for failure.

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

### Compression.CompressSb

`Chilkat 11.7.0 · wc · Compression · CompressSb · method · since 9.5.0.73`

```c
BOOL CkCompressionW_CompressSb(HCkCompressionW cHandle, HCkStringBuilderW sb, HCkBinDataW binData);
```

Compresses the text contained in a `StringBuilder` and appends the compressed bytes to a `BinData` object.

Text is converted to bytes according to the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.CompressStream

`Chilkat 11.7.0 · wc · Compression · CompressStream · method · since 9.5.0.56`

```c
BOOL CkCompressionW_CompressStream(HCkCompressionW cHandle, HCkStreamW strm);
```

Compresses data from a stream source and writes the compressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or even continuous streams while maintaining stable memory usage.

Returns TRUE for success, FALSE for failure.

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

### Compression.CompressStringENC

`Chilkat 11.7.0 · wc · Compression · CompressStringENC · method`

```c
BOOL CkCompressionW_CompressStringENC(HCkCompressionW cHandle, const wchar_t *str, const wchar_t *outStr);
const wchar_t *CkCompressionW_compressStringENC(HCkCompressionW cHandle, const wchar_t *str);
```

Compresses a string and returns the compressed result as an encoded string.

The string is first converted to bytes using `Charset`, then compressed, and finally encoded according to `EncodingMode`.

This method is not `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.DecompressBd

`Chilkat 11.7.0 · wc · Compression · DecompressBd · method · since 9.5.0.66`

```c
BOOL CkCompressionW_DecompressBd(HCkCompressionW cHandle, HCkBinDataW bd);
```

Decompresses the compressed data contained in a `BinData` object.

The `BinData` object is modified to contain the decompressed result.

This method is not `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.DecompressBd2

`Chilkat 11.7.0 · wc · Compression · DecompressBd2 · method · since 11.0.0`

```c
BOOL CkCompressionW_DecompressBd2(HCkCompressionW cHandle, HCkBinDataW bdIn, HCkBinDataW bdOut);
```

Decompresses the data in one `BinData` object and appends the decompressed output to another `BinData` object.

The input `BinData` is not modified.

This method is `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.DecompressFile

`Chilkat 11.7.0 · wc · Compression · DecompressFile · method`

```c
BOOL CkCompressionW_DecompressFile(HCkCompressionW cHandle, const wchar_t *srcPath, const wchar_t *destPath);
```

Decompresses a source file and writes the decompressed data to a destination file.

The file is processed internally in streaming mode, allowing files of any size to be decompressed without loading the entire file into memory.

Returns TRUE for success, FALSE for failure.

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

### Compression.DecompressSb

`Chilkat 11.7.0 · wc · Compression · DecompressSb · method · since 9.5.0.73`

```c
BOOL CkCompressionW_DecompressSb(HCkCompressionW cHandle, HCkBinDataW binData, HCkStringBuilderW sb);
```

Decompresses compressed data from a `BinData` object and appends the resulting text to a `StringBuilder`.

The decompressed bytes are converted to text using the `Charset` property.

This method is `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.DecompressStream

`Chilkat 11.7.0 · wc · Compression · DecompressStream · method · since 9.5.0.56`

```c
BOOL CkCompressionW_DecompressStream(HCkCompressionW cHandle, HCkStreamW strm);
```

Decompresses data from a stream source and writes the decompressed data to the stream sink.

The operation is performed in streaming mode, making it suitable for very large or continuous streams while maintaining stable memory usage.

Returns TRUE for success, FALSE for failure.

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

### Compression.DecompressStringENC

`Chilkat 11.7.0 · wc · Compression · DecompressStringENC · method`

```c
BOOL CkCompressionW_DecompressStringENC(HCkCompressionW cHandle, const wchar_t *encodedCompressedData, const wchar_t *outStr);
const wchar_t *CkCompressionW_decompressStringENC(HCkCompressionW cHandle, const wchar_t *encodedCompressedData);
```

Decompresses compressed data supplied as an encoded string and returns the resulting text.

The input string is decoded according to `EncodingMode`, then decompressed. The resulting bytes are converted to text using `Charset`.

This method is not `FirstChunk` / `LastChunk` aware.

Returns TRUE for success, FALSE for failure.

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

### Compression.DecryptDecompressFile

`Chilkat 11.7.0 · wc · Compression · DecryptDecompressFile · method · since 9.5.0.99`

```c
BOOL CkCompressionW_DecryptDecompressFile(HCkCompressionW cHandle, HCkJsonObjectW cryptParams, const wchar_t *srcPath, const wchar_t *destPath);
```

Decrypts and decompresses a file, writing the restored data to a destination file.

This is the reverse operation of `CompressEncryptFile`.

Returns TRUE for success, FALSE for failure.

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

### Compression.LoadTaskCaller

`Chilkat 11.7.0 · wc · Compression · LoadTaskCaller · method · since 9.5.0.80`

```c
BOOL CkCompressionW_LoadTaskCaller(HCkCompressionW cHandle, HCkTaskW task);
```

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

## 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 CkCompressionW_CompressBdAsync(HCkCompressionW cHandle, HCkBinDataW bd);
HCkTaskW CkCompressionW_CompressBd2Async(HCkCompressionW cHandle, HCkBinDataW bdIn, HCkBinDataW bdOut);
HCkTaskW CkCompressionW_CompressEncryptFileAsync(HCkCompressionW cHandle, HCkJsonObjectW cryptParams, const wchar_t *srcPath, const wchar_t *destPath);
HCkTaskW CkCompressionW_CompressFileAsync(HCkCompressionW cHandle, const wchar_t *srcPath, const wchar_t *destPath);
HCkTaskW CkCompressionW_CompressSbAsync(HCkCompressionW cHandle, HCkStringBuilderW sb, HCkBinDataW binData);
HCkTaskW CkCompressionW_CompressStreamAsync(HCkCompressionW cHandle, HCkStreamW strm);
HCkTaskW CkCompressionW_CompressStringENCAsync(HCkCompressionW cHandle, const wchar_t *str);
HCkTaskW CkCompressionW_DecompressBdAsync(HCkCompressionW cHandle, HCkBinDataW bd);
HCkTaskW CkCompressionW_DecompressBd2Async(HCkCompressionW cHandle, HCkBinDataW bdIn, HCkBinDataW bdOut);
HCkTaskW CkCompressionW_DecompressFileAsync(HCkCompressionW cHandle, const wchar_t *srcPath, const wchar_t *destPath);
HCkTaskW CkCompressionW_DecompressSbAsync(HCkCompressionW cHandle, HCkBinDataW binData, HCkStringBuilderW sb);
HCkTaskW CkCompressionW_DecompressStreamAsync(HCkCompressionW cHandle, HCkStreamW strm);
HCkTaskW CkCompressionW_DecompressStringENCAsync(HCkCompressionW cHandle, const wchar_t *encodedCompressedData);
HCkTaskW CkCompressionW_DecryptDecompressFileAsync(HCkCompressionW cHandle, HCkJsonObjectW cryptParams, const wchar_t *srcPath, const wchar_t *destPath);
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `BeginCompressBytes` | method | before 11.6.1 | `FirstChunk` |
| `BeginCompressBytes2` | method | before 11.6.1 | `FirstChunk` |
| `BeginCompressBytesENC` | method | before 11.6.1 | — |
| `BeginCompressString` | method | before 11.6.1 | `FirstChunk` |
| `BeginCompressStringENC` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressBytes` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressBytes2` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressBytesENC` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressString` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressStringENC` | method | before 11.6.1 | `FirstChunk` |
| `CompressBytes` | method | before 11.6.1 | — |
| `CompressBytes2` | method | before 11.6.1 | — |
| `CompressBytesENC` | method | before 11.6.1 | — |
| `CompressStr` | method | before 11.6.1 | — |
| `CompressString` | method | before 11.6.1 | — |
| `DecompressBytes` | method | before 11.6.1 | — |
| `DecompressBytes2` | method | before 11.6.1 | — |
| `DecompressBytesENC` | method | before 11.6.1 | — |
| `DecompressString` | method | before 11.6.1 | — |
| `EndCompressBytes` | method | before 11.6.1 | — |
| `EndCompressBytesENC` | method | before 11.6.1 | — |
| `EndCompressString` | method | before 11.6.1 | — |
| `EndCompressStringENC` | method | before 11.6.1 | — |
| `EndDecompressBytes` | method | before 11.6.1 | — |
| `EndDecompressBytesENC` | method | before 11.6.1 | — |
| `EndDecompressString` | method | before 11.6.1 | — |
| `EndDecompressStringENC` | method | before 11.6.1 | — |
| `MoreCompressBytes` | method | before 11.6.1 | — |
| `MoreCompressBytes2` | method | before 11.6.1 | — |
| `MoreCompressBytesENC` | method | before 11.6.1 | — |
| `MoreCompressString` | method | before 11.6.1 | — |
| `MoreCompressStringENC` | method | before 11.6.1 | — |
| `MoreDecompressBytes` | method | before 11.6.1 | — |
| `MoreDecompressBytes2` | method | before 11.6.1 | — |
| `MoreDecompressBytesENC` | method | before 11.6.1 | — |
| `MoreDecompressString` | method | before 11.6.1 | — |
| `MoreDecompressStringENC` | method | before 11.6.1 | — |

## Related classes

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

