---
product: Chilkat
product_version: 11.7.0
language: foxpro
language_label: FoxPro
class: Compression
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/foxpro_CompressionRef.html
---
# Chilkat Compression — FoxPro — v11.7.0

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

```foxpro
loCompression = CreateObject('Chilkat.Compression')
```

Visual FoxPro is a 32-bit application and therefore uses the 32-bit Chilkat ActiveX. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `CreateObject('Chilkat.Compression.11')` for Chilkat v11.\*.\*.

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

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` | `DebugLogFilePath As String` | 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` | `LastBinaryResult As Variant (read-only)` | 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` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Number` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `LastStringResult As String (read-only)` | 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` | `LastStringResultLen As Number (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging As Number` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `Algorithm` | property, read/write | `Algorithm As String` |
| `Charset` | property, read/write | `Charset As String` |
| `DeflateLevel` | property, read/write | `DeflateLevel As Number` |
| `EncodingMode` | property, read/write | `EncodingMode As String` |
| `FirstChunk` | property, read/write | `FirstChunk As Number` |
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Number` |
| `LastChunk` | property, read/write | `LastChunk As Number` |
| `UncommonOptions` | property, read/write | `UncommonOptions As String` |
| `CompressBd` | method | `CompressBd(bd As ChilkatBinData) As Number` |
| `CompressBd2` | method | `CompressBd2(bdIn As ChilkatBinData, bdOut As ChilkatBinData) As Number` |
| `CompressBytes` | method | `CompressBytes(data As Variant) As Variant` |
| `CompressBytesENC` | method | `CompressBytesENC(data As Variant) As String` |
| `CompressEncryptFile` | method | `CompressEncryptFile(cryptParams As ChilkatJsonObject, srcPath As String, destPath As String) As Number` |
| `CompressFile` | method | `CompressFile(srcPath As String, destPath As String) As Number` |
| `CompressSb` | method | `CompressSb(sb As ChilkatStringBuilder, binData As ChilkatBinData) As Number` |
| `CompressStr` | method | `CompressStr(str As String, bd As ChilkatBinData) As Number` |
| `CompressStream` | method | `CompressStream(strm As ChilkatStream) As Number` |
| `CompressString` | method | `CompressString(str As String) As Variant` |
| `CompressStringENC` | method | `CompressStringENC(str As String) As String` |
| `DecompressBd` | method | `DecompressBd(bd As ChilkatBinData) As Number` |
| `DecompressBd2` | method | `DecompressBd2(bdIn As ChilkatBinData, bdOut As ChilkatBinData) As Number` |
| `DecompressBytes` | method | `DecompressBytes(data As Variant) As Variant` |
| `DecompressBytesENC` | method | `DecompressBytesENC(encodedCompressedData As String) As Variant` |
| `DecompressFile` | method | `DecompressFile(srcPath As String, destPath As String) As Number` |
| `DecompressSb` | method | `DecompressSb(binData As ChilkatBinData, sb As ChilkatStringBuilder) As Number` |
| `DecompressStream` | method | `DecompressStream(strm As ChilkatStream) As Number` |
| `DecompressString` | method | `DecompressString(data As Variant) As String` |
| `DecompressStringENC` | method | `DecompressStringENC(encodedCompressedData As String) As String` |
| `DecryptDecompressFile` | method | `DecryptDecompressFile(cryptParams As ChilkatJsonObject, srcPath As String, destPath As String) As Number` |
| `LoadTaskCaller` | method | `LoadTaskCaller(task As ChilkatTask) As Number` |

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

```foxpro
Algorithm As String
```

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

```foxpro
Charset As String
```

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

```foxpro
DeflateLevel As Number
```

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

```foxpro
EncodingMode As String
```

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

```foxpro
FirstChunk As Number
```

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 · foxpro · Compression · HeartbeatMs · property · read/write`

```foxpro
HeartbeatMs As Number
```

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

```foxpro
LastChunk As Number
```

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 · foxpro · Compression · UncommonOptions · property · read/write · since 11.0.0`

```foxpro
UncommonOptions As String
```

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

```foxpro
CompressBd(bd As ChilkatBinData) As Number
```

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 · foxpro · Compression · CompressBd2 · method · since 11.0.0`

```foxpro
CompressBd2(bdIn As ChilkatBinData, bdOut As ChilkatBinData) As Number
```

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 · foxpro · Compression · CompressBytes · method`

```foxpro
CompressBytes(data As Variant) As Variant
```

Compresses a byte array and returns the compressed bytes.

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

Returns a zero-length byte array (as a Variant) on failure.

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

### Compression.CompressBytesENC

`Chilkat 11.7.0 · foxpro · Compression · CompressBytesENC · method`

```foxpro
CompressBytesENC(data As Variant) As String
```

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 `.NULL.` on failure

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

### Compression.CompressEncryptFile

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

```foxpro
CompressEncryptFile(cryptParams As ChilkatJsonObject, srcPath As String, destPath As String) As Number
```

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 · foxpro · Compression · CompressFile · method`

```foxpro
CompressFile(srcPath As String, destPath As String) As Number
```

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 · foxpro · Compression · CompressSb · method · since 9.5.0.73`

```foxpro
CompressSb(sb As ChilkatStringBuilder, binData As ChilkatBinData) As Number
```

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 · foxpro · Compression · CompressStr · method · since 11.0.0`

```foxpro
CompressStr(str As String, bd As ChilkatBinData) As Number
```

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 · foxpro · Compression · CompressStream · method · since 9.5.0.56`

```foxpro
CompressStream(strm As ChilkatStream) As Number
```

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 · foxpro · Compression · CompressString · method`

```foxpro
CompressString(str As String) As Variant
```

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 a Variant) on failure.

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

### Compression.CompressStringENC

`Chilkat 11.7.0 · foxpro · Compression · CompressStringENC · method`

```foxpro
CompressStringENC(str As String) As String
```

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 `.NULL.` on failure

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

### Compression.DecompressBd

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

```foxpro
DecompressBd(bd As ChilkatBinData) As Number
```

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 · foxpro · Compression · DecompressBd2 · method · since 11.0.0`

```foxpro
DecompressBd2(bdIn As ChilkatBinData, bdOut As ChilkatBinData) As Number
```

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 · foxpro · Compression · DecompressBytes · method`

```foxpro
DecompressBytes(data As Variant) As Variant
```

Decompresses compressed byte data and returns the decompressed bytes.

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

Returns a zero-length byte array (as a Variant) on failure.

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

### Compression.DecompressBytesENC

`Chilkat 11.7.0 · foxpro · Compression · DecompressBytesENC · method`

```foxpro
DecompressBytesENC(encodedCompressedData As String) As Variant
```

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 a Variant) on failure.

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

### Compression.DecompressFile

`Chilkat 11.7.0 · foxpro · Compression · DecompressFile · method`

```foxpro
DecompressFile(srcPath As String, destPath As String) As Number
```

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 · foxpro · Compression · DecompressSb · method · since 9.5.0.73`

```foxpro
DecompressSb(binData As ChilkatBinData, sb As ChilkatStringBuilder) As Number
```

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 · foxpro · Compression · DecompressStream · method · since 9.5.0.56`

```foxpro
DecompressStream(strm As ChilkatStream) As Number
```

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 · foxpro · Compression · DecompressString · method`

```foxpro
DecompressString(data As Variant) As String
```

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 `.NULL.` on failure

### Compression.DecompressStringENC

`Chilkat 11.7.0 · foxpro · Compression · DecompressStringENC · method`

```foxpro
DecompressStringENC(encodedCompressedData As String) As String
```

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 `.NULL.` on failure

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

### Compression.DecryptDecompressFile

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

```foxpro
DecryptDecompressFile(cryptParams As ChilkatJsonObject, srcPath As String, destPath As String) As Number
```

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 · foxpro · Compression · LoadTaskCaller · method · since 9.5.0.80`

```foxpro
LoadTaskCaller(task As ChilkatTask) As Number
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

## Events and callbacks

A Visual FoxPro application receives Chilkat ActiveX events by defining a class that `IMPLEMENTS` the `_IChilkatEvents` interface, creating an instance of it, and binding that instance to the Chilkat object with `EVENTHANDLER()`. Visual FoxPro requires the class to implement every method of the interface, so the class below includes a `PROCEDURE` for each event; leave the ones you do not need empty. The `TextData` and `BinaryData` events are defunct: they are deprecated and are never called, but their procedures must still exist because the interface declares them.

**Important:** Event callbacks from ***asynchronous method calls*** are generally not possible from the ActiveX. Events fire during synchronous method calls.

```foxpro
compressionEventHandler = CREATEOBJECT("MyCompressionEvents")
loCompression = CreateObject('Chilkat.Compression')
EVENTHANDLER(loCompression, compressionEventHandler)

DEFINE CLASS MyCompressionEvents AS SESSION OLEPUBLIC
IMPLEMENTS _IChilkatEvents IN "Chilkat.Compression"

PROCEDURE _IChilkatEvents_AbortCheck(abort As Number)
? "AbortCheck"
ENDPROC

* The BinaryData event is defunct: it is deprecated and is never called.
* The procedure must exist because the interface declares it, but it can be left empty.
PROCEDURE _IChilkatEvents_BinaryData(data As Variant)
ENDPROC

PROCEDURE _IChilkatEvents_PercentDone(pctDone As Number, abort As Number)
? "PercentDone"
ENDPROC

PROCEDURE _IChilkatEvents_ProgressInfo(name As String, value As String)
? "ProgressInfo"
ENDPROC

PROCEDURE _IChilkatEvents_TaskCompleted(task As Generic)
? "TaskCompleted"
ENDPROC

* The TextData event is defunct: it is deprecated and is never called.
* The procedure must exist because the interface declares it, but it can be left empty.
PROCEDURE _IChilkatEvents_TextData(data As String)
ENDPROC


ENDDEFINE
```

### Compression.AbortCheck (event)

`Chilkat 11.7.0 · foxpro · Compression · AbortCheck · event`

```foxpro
AbortCheck(abort As Number)
```

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.

**FoxPro event implementation:**

```foxpro
* Add to the MyCompressionEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_AbortCheck(abort As Number)
    * Set abort to 1 to abort the method in progress.
ENDPROC
```

### Compression.PercentDone (event)

`Chilkat 11.7.0 · foxpro · Compression · PercentDone · event`

```foxpro
PercentDone(pctDone As Number, abort As Number)
```

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.

**FoxPro event implementation:**

```foxpro
* Add to the MyCompressionEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_PercentDone(pctDone As Number, abort As Number)
    * pctDone ranges from 1 to 100.  Set abort to 1 to abort the method in progress.
ENDPROC
```

### Compression.ProgressInfo (event)

`Chilkat 11.7.0 · foxpro · Compression · ProgressInfo · event`

```foxpro
ProgressInfo(name As String, value As String)
```

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.

**FoxPro event implementation:**

```foxpro
* Add to the MyCompressionEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_ProgressInfo(name As String, value As String)
    ? name + ": " + value
ENDPROC
```

### Compression.TaskCompleted (event)

`Chilkat 11.7.0 · foxpro · Compression · TaskCompleted · event`

```foxpro
TaskCompleted(task As ChilkatTask)
```

Called from the background thread when an asynchronous task completes.

**FoxPro event implementation:**

```foxpro
* Add to the MyCompressionEvents class shown in the Events overview above.
PROCEDURE _IChilkatEvents_TaskCompleted(task As Generic)
    * task is the Task object that has completed.
ENDPROC
```

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

```foxpro
CompressBdAsync(bd As ChilkatBinData) As ChilkatTask
CompressBd2Async(bdIn As ChilkatBinData, bdOut As ChilkatBinData) As ChilkatTask
CompressBytesAsync(data As Variant) As ChilkatTask
CompressBytesENCAsync(data As Variant) As ChilkatTask
CompressEncryptFileAsync(cryptParams As ChilkatJsonObject, srcPath As String, destPath As String) As ChilkatTask
CompressFileAsync(srcPath As String, destPath As String) As ChilkatTask
CompressSbAsync(sb As ChilkatStringBuilder, binData As ChilkatBinData) As ChilkatTask
CompressStrAsync(str As String, bd As ChilkatBinData) As ChilkatTask
CompressStreamAsync(strm As ChilkatStream) As ChilkatTask
CompressStringAsync(str As String) As ChilkatTask
CompressStringENCAsync(str As String) As ChilkatTask
DecompressBdAsync(bd As ChilkatBinData) As ChilkatTask
DecompressBd2Async(bdIn As ChilkatBinData, bdOut As ChilkatBinData) As ChilkatTask
DecompressBytesAsync(data As Variant) As ChilkatTask
DecompressBytesENCAsync(encodedCompressedData As String) As ChilkatTask
DecompressFileAsync(srcPath As String, destPath As String) As ChilkatTask
DecompressSbAsync(binData As ChilkatBinData, sb As ChilkatStringBuilder) As ChilkatTask
DecompressStreamAsync(strm As ChilkatStream) As ChilkatTask
DecompressStringENCAsync(encodedCompressedData As String) As ChilkatTask
DecryptDecompressFileAsync(cryptParams As ChilkatJsonObject, srcPath As String, destPath As String) As ChilkatTask
```

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

