---
product: Chilkat
product_version: 11.7.0
language: delphix
language_label: Delphi ActiveX
class: Compression
class_name: TChilkatCompression
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/delphiCompressionRef.html
---
# Chilkat Compression — Delphi ActiveX — v11.7.0

> Chilkat 11.7.0 · language=delphix · class=Compression (TChilkatCompression)
> 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/delphix/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

**Object Creation**

```pascal
var
obj: TChilkatCompression;
...
begin
obj := TChilkatCompression.Create(Self);
...
// When finished, free the object instance.
obj.Free();
```

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 Delphi ActiveX.

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` | `property DebugLogFilePath: WideString` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `property LastBinaryResult: OleVariant readonly` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `property LastErrorHtml: WideString readonly` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `property LastErrorText: WideString readonly` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `property LastErrorXml: WideString readonly` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `property LastMethodSuccess: Integer` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `property LastStringResult: WideString readonly` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `property LastStringResultLen: Integer readonly` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `property VerboseLogging: Integer` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `property Version: WideString readonly` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Algorithm` | property, read/write | `property Algorithm: WideString` |
| `Charset` | property, read/write | `property Charset: WideString` |
| `DeflateLevel` | property, read/write | `property DeflateLevel: Integer` |
| `EncodingMode` | property, read/write | `property EncodingMode: WideString` |
| `FirstChunk` | property, read/write | `property FirstChunk: Integer` |
| `HeartbeatMs` | property, read/write | `property HeartbeatMs: Integer` |
| `LastChunk` | property, read/write | `property LastChunk: Integer` |
| `UncommonOptions` | property, read/write | `property UncommonOptions: WideString` |
| `CompressBd` | method | `function CompressBd(bd: IChilkatBinData): Integer;` |
| `CompressBd2` | method | `function CompressBd2(bdIn: IChilkatBinData; bdOut: IChilkatBinData): Integer;` |
| `CompressBytes` | method | `function CompressBytes(data: OleVariant): OleVariant;` |
| `CompressBytesENC` | method | `function CompressBytesENC(data: OleVariant): WideString;` |
| `CompressEncryptFile` | method | `function CompressEncryptFile(cryptParams: IChilkatJsonObject; srcPath: WideString; destPath: WideString): Integer;` |
| `CompressFile` | method | `function CompressFile(srcPath: WideString; destPath: WideString): Integer;` |
| `CompressSb` | method | `function CompressSb(sb: IChilkatStringBuilder; binData: IChilkatBinData): Integer;` |
| `CompressStr` | method | `function CompressStr(str: WideString; bd: IChilkatBinData): Integer;` |
| `CompressStream` | method | `function CompressStream(strm: IChilkatStream): Integer;` |
| `CompressString` | method | `function CompressString(str: WideString): OleVariant;` |
| `CompressStringENC` | method | `function CompressStringENC(str: WideString): WideString;` |
| `DecompressBd` | method | `function DecompressBd(bd: IChilkatBinData): Integer;` |
| `DecompressBd2` | method | `function DecompressBd2(bdIn: IChilkatBinData; bdOut: IChilkatBinData): Integer;` |
| `DecompressBytes` | method | `function DecompressBytes(data: OleVariant): OleVariant;` |
| `DecompressBytesENC` | method | `function DecompressBytesENC(encodedCompressedData: WideString): OleVariant;` |
| `DecompressFile` | method | `function DecompressFile(srcPath: WideString; destPath: WideString): Integer;` |
| `DecompressSb` | method | `function DecompressSb(binData: IChilkatBinData; sb: IChilkatStringBuilder): Integer;` |
| `DecompressStream` | method | `function DecompressStream(strm: IChilkatStream): Integer;` |
| `DecompressString` | method | `function DecompressString(data: OleVariant): WideString;` |
| `DecompressStringENC` | method | `function DecompressStringENC(encodedCompressedData: WideString): WideString;` |
| `DecryptDecompressFile` | method | `function DecryptDecompressFile(cryptParams: IChilkatJsonObject; srcPath: WideString; destPath: WideString): Integer;` |
| `LoadTaskCaller` | method | `function LoadTaskCaller(task: IChilkatTask): Integer;` |

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 · delphix · Compression · Algorithm · property · read/write`

```pascal
property Algorithm: WideString
```

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 · delphix · Compression · Charset · property · read/write`

```pascal
property Charset: WideString
```

**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 · delphix · Compression · DeflateLevel · property · read/write · since 9.5.0.73`

```pascal
property DeflateLevel: Integer
```

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 · delphix · Compression · EncodingMode · property · read/write`

```pascal
property EncodingMode: WideString
```

**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 · delphix · Compression · FirstChunk · property · read/write · since 11.0.0`

```pascal
property FirstChunk: Integer
```

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

The default value is `1`.

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

### Compression.HeartbeatMs

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

```pascal
property HeartbeatMs: Integer
```

**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 · delphix · Compression · LastChunk · property · read/write · since 11.0.0`

```pascal
property LastChunk: Integer
```

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

The default value is `1`.

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

### Compression.UncommonOptions

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

```pascal
property UncommonOptions: WideString
```

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 · delphix · Compression · CompressBd · method · since 9.5.0.66`

```pascal
function CompressBd(bd: IChilkatBinData): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.CompressBd2

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

```pascal
function CompressBd2(bdIn: IChilkatBinData; bdOut: IChilkatBinData): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.CompressBytes

`Chilkat 11.7.0 · delphix · Compression · CompressBytes · method`

```pascal
function CompressBytes(data: OleVariant): OleVariant;
```

Compresses a byte array and returns the compressed bytes.

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

Returns a zero-length byte array (as an OleVariant) on failure.  
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

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

### Compression.CompressBytesENC

`Chilkat 11.7.0 · delphix · Compression · CompressBytesENC · method`

```pascal
function CompressBytesENC(data: OleVariant): WideString;
```

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

The output encoding is controlled by `EncodingMode`.

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

Returns a zero-length WideString on failure

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

### Compression.CompressEncryptFile

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

```pascal
function CompressEncryptFile(cryptParams: IChilkatJsonObject; srcPath: WideString; destPath: WideString): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.CompressFile

`Chilkat 11.7.0 · delphix · Compression · CompressFile · method`

```pascal
function CompressFile(srcPath: WideString; destPath: WideString): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.CompressSb

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

```pascal
function CompressSb(sb: IChilkatStringBuilder; binData: IChilkatBinData): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.CompressStr

`Chilkat 11.7.0 · delphix · Compression · CompressStr · method · since 11.0.0`

```pascal
function CompressStr(str: WideString; bd: IChilkatBinData): Integer;
```

Compresses a string and appends the compressed bytes to a `BinData` object.

The string is converted to bytes using the charset specified by the `Charset` property.

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

Returns 1 for success, 0 for failure.

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

### Compression.CompressStream

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

```pascal
function CompressStream(strm: IChilkatStream): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.CompressString

`Chilkat 11.7.0 · delphix · Compression · CompressString · method`

```pascal
function CompressString(str: WideString): OleVariant;
```

Compresses a string and returns the compressed bytes.

The string is converted to bytes using the `Charset` property.

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

Returns a zero-length byte array (as an OleVariant) on failure.  
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

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

### Compression.CompressStringENC

`Chilkat 11.7.0 · delphix · Compression · CompressStringENC · method`

```pascal
function CompressStringENC(str: WideString): WideString;
```

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 a zero-length WideString on failure

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

### Compression.DecompressBd

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

```pascal
function DecompressBd(bd: IChilkatBinData): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.DecompressBd2

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

```pascal
function DecompressBd2(bdIn: IChilkatBinData; bdOut: IChilkatBinData): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.DecompressBytes

`Chilkat 11.7.0 · delphix · Compression · DecompressBytes · method`

```pascal
function DecompressBytes(data: OleVariant): OleVariant;
```

Decompresses compressed byte data and returns the decompressed bytes.

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

Returns a zero-length byte array (as an OleVariant) on failure.  
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

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

### Compression.DecompressBytesENC

`Chilkat 11.7.0 · delphix · Compression · DecompressBytesENC · method`

```pascal
function DecompressBytesENC(encodedCompressedData: WideString): OleVariant;
```

Decompresses compressed data supplied as an encoded string and returns the decompressed bytes.

The input string is decoded according to `EncodingMode` before being decompressed.

Returns a zero-length byte array (as an OleVariant) on failure.  
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

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

### Compression.DecompressFile

`Chilkat 11.7.0 · delphix · Compression · DecompressFile · method`

```pascal
function DecompressFile(srcPath: WideString; destPath: WideString): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.DecompressSb

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

```pascal
function DecompressSb(binData: IChilkatBinData; sb: IChilkatStringBuilder): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.DecompressStream

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

```pascal
function DecompressStream(strm: IChilkatStream): Integer;
```

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 1 for success, 0 for failure.

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

### Compression.DecompressString

`Chilkat 11.7.0 · delphix · Compression · DecompressString · method`

```pascal
function DecompressString(data: OleVariant): WideString;
```

Decompresses compressed byte data and returns the resulting string.

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

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

Returns a zero-length WideString on failure

### Compression.DecompressStringENC

`Chilkat 11.7.0 · delphix · Compression · DecompressStringENC · method`

```pascal
function DecompressStringENC(encodedCompressedData: WideString): WideString;
```

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 a zero-length WideString on failure

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

### Compression.DecryptDecompressFile

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

```pascal
function DecryptDecompressFile(cryptParams: IChilkatJsonObject; srcPath: WideString; destPath: WideString): Integer;
```

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

This is the reverse operation of `CompressEncryptFile`.

Returns 1 for success, 0 for failure.

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

### Compression.LoadTaskCaller

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

```pascal
function LoadTaskCaller(task: IChilkatTask): Integer;
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

## Events and callbacks

### Compression.AbortCheck (event)

`Chilkat 11.7.0 · delphix · Compression · AbortCheck · event`

```pascal
procedure AbortCheck(ASender: TObject;  out abort: Integer);
```

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.

**Delphi ActiveX event callback implementation:**

To handle this event, implement a procedure with the signature shown below and assign it to the object's AbortCheck event. If you dropped the component onto a form, double-clicking the event in the Object Inspector creates the empty procedure for you.

```pascal
procedure TForm1.compressionAbortCheck(ASender: TObject;  out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  compression: TChilkatCompression;

begin
  compression := TChilkatCompression.Create(Self);
  compression.OnAbortCheck := compressionAbortCheck;
  // ...
```

### Compression.PercentDone (event)

`Chilkat 11.7.0 · delphix · Compression · PercentDone · event`

```pascal
procedure PercentDone(ASender: TObject;  pctDone: Integer; out abort: Integer);
```

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 `1`. This will cause the method to terminate and return a failure status or corresponding failure value.

**Delphi ActiveX event callback implementation:**

To handle this event, implement a procedure with the signature shown below and assign it to the object's PercentDone event. If you dropped the component onto a form, double-clicking the event in the Object Inspector creates the empty procedure for you.

```pascal
procedure TForm1.compressionPercentDone(ASender: TObject;  pctDone: Integer; out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  compression: TChilkatCompression;

begin
  compression := TChilkatCompression.Create(Self);
  compression.OnPercentDone := compressionPercentDone;
  // ...
```

### Compression.ProgressInfo (event)

`Chilkat 11.7.0 · delphix · Compression · ProgressInfo · event`

```pascal
procedure ProgressInfo(ASender: TObject;  const name: WideString; const value: WideString);
```

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.

**Delphi ActiveX event callback implementation:**

To handle this event, implement a procedure with the signature shown below and assign it to the object's ProgressInfo event. If you dropped the component onto a form, double-clicking the event in the Object Inspector creates the empty procedure for you.

```pascal
procedure TForm1.compressionProgressInfo(ASender: TObject;  const name: WideString; const value: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  compression: TChilkatCompression;

begin
  compression := TChilkatCompression.Create(Self);
  compression.OnProgressInfo := compressionProgressInfo;
  // ...
```

### Compression.TaskCompleted (event)

`Chilkat 11.7.0 · delphix · Compression · TaskCompleted · event`

```pascal
procedure TaskCompleted(ASender: TObject;  const task: IChilkatTask);
```

Called from the background thread when an asynchronous task completes.

**Delphi ActiveX event callback implementation:**

To handle this event, implement a procedure with the signature shown below and assign it to the object's TaskCompleted event. If you dropped the component onto a form, double-clicking the event in the Object Inspector creates the empty procedure for you.

```pascal
procedure TForm1.compressionTaskCompleted(ASender: TObject;  const task: IChilkatTask);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  compression: TChilkatCompression;

begin
  compression := TChilkatCompression.Create(Self);
  compression.OnTaskCompleted := compressionTaskCompleted;
  // ...
```

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

```pascal
function CompressBdAsync(bd: IChilkatBinData): IChilkatTask;
function CompressBd2Async(bdIn: IChilkatBinData; bdOut: IChilkatBinData): IChilkatTask;
function CompressBytesAsync(data: OleVariant): IChilkatTask;
function CompressBytesENCAsync(data: OleVariant): IChilkatTask;
function CompressEncryptFileAsync(cryptParams: IChilkatJsonObject; srcPath: WideString; destPath: WideString): IChilkatTask;
function CompressFileAsync(srcPath: WideString; destPath: WideString): IChilkatTask;
function CompressSbAsync(sb: IChilkatStringBuilder; binData: IChilkatBinData): IChilkatTask;
function CompressStrAsync(str: WideString; bd: IChilkatBinData): IChilkatTask;
function CompressStreamAsync(strm: IChilkatStream): IChilkatTask;
function CompressStringAsync(str: WideString): IChilkatTask;
function CompressStringENCAsync(str: WideString): IChilkatTask;
function DecompressBdAsync(bd: IChilkatBinData): IChilkatTask;
function DecompressBd2Async(bdIn: IChilkatBinData; bdOut: IChilkatBinData): IChilkatTask;
function DecompressBytesAsync(data: OleVariant): IChilkatTask;
function DecompressBytesENCAsync(encodedCompressedData: WideString): IChilkatTask;
function DecompressFileAsync(srcPath: WideString; destPath: WideString): IChilkatTask;
function DecompressSbAsync(binData: IChilkatBinData; sb: IChilkatStringBuilder): IChilkatTask;
function DecompressStreamAsync(strm: IChilkatStream): IChilkatTask;
function DecompressStringENCAsync(encodedCompressedData: WideString): IChilkatTask;
function DecryptDecompressFileAsync(cryptParams: IChilkatJsonObject; srcPath: WideString; destPath: WideString): IChilkatTask;
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `BeginCompressBytes` | 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` |
| `BeginDecompressBytesENC` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressString` | method | before 11.6.1 | `FirstChunk` |
| `BeginDecompressStringENC` | method | before 11.6.1 | `FirstChunk` |
| `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 | — |
| `MoreCompressBytesENC` | method | before 11.6.1 | — |
| `MoreCompressString` | method | before 11.6.1 | — |
| `MoreCompressStringENC` | method | before 11.6.1 | — |
| `MoreDecompressBytes` | 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/delphix/classes/BinData.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/JsonObject.md), [`Stream`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/Stream.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphix/classes/Task.md)

