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

> Chilkat 11.7.0 · language=delphix · class=Gzip (TChilkatGzip)
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/Gzip.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, decompress, inspect, and convert GZIP data in files or memory.**

`Chilkat.Gzip` provides GZIP compression and decompression for file-based and in-memory workflows. It can compress and uncompress files, strings, byte arrays, `BinData`, and encoded data such as Base64 or hex. It also supports `.tar.gz` extraction, gzip metadata such as original filename, timestamp, and comments, and inspection of GZIP header information without fully expanding the compressed data.

**File compression**

Compress files to `.gz`, uncompress `.gz` files, and write decompressed output directly to disk.

**Memory-based data**

Work with byte arrays and `Chilkat.BinData` for applications that need compression or decompression without temporary files.

**String workflows**

Compress and uncompress strings with explicit charset handling for text data that must round-trip correctly.

**Encoded GZIP data**

Handle GZIP data represented as Base64, hex, or other supported encoded forms when binary data must be carried as text.

**GZIP metadata**

Set or inspect metadata such as original filename, modified time, comments, and extra data stored in the GZIP header.

**Tar-gzip and XFDL**

Extract `.tar.gz` archives and decode XFDL content that uses gzip-related encodings.

**Common pattern:** Use `Gzip` when the data is a single GZIP stream, a `.gz` file, or a `.tar.gz` archive. For ZIP archives, use `Chilkat.Zip`; for raw deflate or zlib-style compression, use `Chilkat.Compression`.

For an extended overview, see [Gzip Class Overview](https://www.chilkatsoft.com/gzip_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

```pascal
var
obj: TChilkatGzip;
...
begin
obj := TChilkatGzip.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 |
|---|---|---|
| `AbortCurrent` | property, read/write | `property AbortCurrent: Integer` |
| `Comment` | property, read/write | `property Comment: WideString` |
| `CompressionLevel` | property, read/write | `property CompressionLevel: Integer` |
| `ExtraData` | property, read/write | `property ExtraData: OleVariant` |
| `Filename` | property, read/write | `property Filename: WideString` |
| `HeartbeatMs` | property, read/write | `property HeartbeatMs: Integer` |
| `LastModStr` | property, read/write | `property LastModStr: WideString` |
| `UseCurrentDate` | property, read/write | `property UseCurrentDate: Integer` |
| `CompressBd` | method | `function CompressBd(binDat: IChilkatBinData): Integer;` |
| `CompressFile` | method | `function CompressFile(srcPath: WideString; destPath: WideString): Integer;` |
| `CompressFile2` | method | `function CompressFile2(srcPath: WideString; embeddedFilename: WideString; destPath: WideString): Integer;` |
| `CompressFileBd` | method | `function CompressFileBd(filePath: WideString; bd: IChilkatBinData): Integer;` |
| `CompressFileToMem` | method | `function CompressFileToMem(inFilename: WideString): OleVariant;` |
| `CompressMemory` | method | `function CompressMemory(inData: OleVariant): OleVariant;` |
| `CompressMemToFile` | method | `function CompressMemToFile(inData: OleVariant; destPath: WideString): Integer;` |
| `CompressSb` | method | `function CompressSb(sb: IChilkatStringBuilder; charset: WideString; bd: IChilkatBinData): Integer;` |
| `CompressString` | method | `function CompressString(inStr: WideString; destCharset: WideString): OleVariant;` |
| `CompressStringENC` | method | `function CompressStringENC(inStr: WideString; charset: WideString; encoding: WideString): WideString;` |
| `CompressStringToFile` | method | `function CompressStringToFile(inStr: WideString; destCharset: WideString; destPath: WideString): Integer;` |
| `GetGzipInfo` | method | `function GetGzipInfo(filePath: WideString; json: IChilkatJsonObject): Integer;` |
| `GetGzipInfoBd` | method | `function GetGzipInfoBd(bd: IChilkatBinData; json: IChilkatJsonObject): Integer;` |
| `IsGzip` | method | `function IsGzip(bd: IChilkatBinData): Integer;` |
| `LoadTaskCaller` | method | `function LoadTaskCaller(task: IChilkatTask): Integer;` |
| `SetDt` | method | `function SetDt(dt: ICkDateTime): Integer;` |
| `SetExtraData` | method | `function SetExtraData(encodedData: WideString; encoding: WideString): Integer;` |
| `UncompressBd` | method | `function UncompressBd(binDat: IChilkatBinData): Integer;` |
| `UncompressBdToFile` | method | `function UncompressBdToFile(bd: IChilkatBinData; filePath: WideString): Integer;` |
| `UncompressFile` | method | `function UncompressFile(srcPath: WideString; destPath: WideString): Integer;` |
| `UncompressFileToMem` | method | `function UncompressFileToMem(srcPath: WideString): OleVariant;` |
| `UncompressFileToString` | method | `function UncompressFileToString(srcPath: WideString; charset: WideString): WideString;` |
| `UncompressMemory` | method | `function UncompressMemory(inData: OleVariant): OleVariant;` |
| `UncompressMemToFile` | method | `function UncompressMemToFile(inData: OleVariant; destPath: WideString): Integer;` |
| `UncompressString` | method | `function UncompressString(inData: OleVariant; inCharset: WideString): WideString;` |
| `UncompressStringENC` | method | `function UncompressStringENC(inStr: WideString; charset: WideString; encoding: WideString): WideString;` |
| `UnTarGz` | method | `function UnTarGz(gzPath: WideString; destDir: WideString; bNoAbsolute: Integer): Integer;` |
| `XfdlToXml` | method | `function XfdlToXml(xfldData: WideString): WideString;` |

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

## Properties

### Gzip.AbortCurrent

`Chilkat 11.7.0 · delphix · Gzip · AbortCurrent · property · read/write · since 9.5.0.58`

```pascal
property AbortCurrent: Integer
```

Set this property to `1` to request that the currently running operation be aborted. This is useful for long-running operations such as large file compression or decompression. Methods that complete quickly are generally not affected.

If no method is currently running, the property is automatically reset to `0` when the next method begins. After an abort occurs, it is also reset to `0`. Both synchronous and asynchronous operations can be aborted. For synchronous calls, another thread must set this property.

### Gzip.Comment

`Chilkat 11.7.0 · delphix · Gzip · Comment · property · read/write`

```pascal
property Comment: WideString
```

An optional comment to embed in the Gzip file when a `Compress*` method is called.

### Gzip.CompressionLevel

`Chilkat 11.7.0 · delphix · Gzip · CompressionLevel · property · read/write · since 9.5.0.50`

```pascal
property CompressionLevel: Integer
```

Controls the compression level used when creating Gzip data. The value can range from `0` to `9`.

- `0` = no compression
- `9` = maximum compression

The default value is `6`, which is a typical balance between compression size and speed. Higher levels may take significantly more CPU time while producing only slightly smaller output, depending on the data.

### Gzip.ExtraData

`Chilkat 11.7.0 · delphix · Gzip · ExtraData · property · read/write`

```pascal
property ExtraData: OleVariant
```

Optional binary data to include in the Gzip header when a `Compress*` method is called.

### Gzip.Filename

`Chilkat 11.7.0 · delphix · Gzip · Filename · property · read/write`

```pascal
property Filename: WideString
```

The filename to embed in the Gzip file when a `Compress*` method is called. Some Gzip extraction tools use this embedded filename as the default output filename.

### Gzip.HeartbeatMs

`Chilkat 11.7.0 · delphix · Gzip · 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. These callbacks allow an application to cancel certain long-running operations before they finish.

The default value is `0`, which means no `AbortCheck` callbacks are triggered.

### Gzip.LastModStr

`Chilkat 11.7.0 · delphix · Gzip · LastModStr · property · read/write`

```pascal
property LastModStr: WideString
```

Specifies the last-modified date/time to embed in the Gzip file when a `Compress*` method is called.

The value must be provided as an RFC 822 formatted date/time string.

**Example:**

```
Sun, 12 Apr 2026 12:45:26 GMT
```

If this property is not set, the current system date/time is used automatically.

### Gzip.UseCurrentDate

`Chilkat 11.7.0 · delphix · Gzip · UseCurrentDate · property · read/write`

```pascal
property UseCurrentDate: Integer
```

Controls the last-modified date/time assigned to files created by `Uncompress*` methods.

When set to `1`, the extracted file uses the current date/time instead of the date/time stored in the Gzip data.

## Methods

### Gzip.CompressBd

`Chilkat 11.7.0 · delphix · Gzip · CompressBd · method · since 9.5.0.67`

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

Compresses the contents of a `BinData` object in place, replacing the original data with Gzip-compressed data.

Returns 1 for success, 0 for failure.

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

### Gzip.CompressFile

`Chilkat 11.7.0 · delphix · Gzip · CompressFile · method`

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

Compresses a file and writes the result as a Gzip file, typically with a `.gz` extension.

Returns 1 for success, 0 for failure.

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

### Gzip.CompressFile2

`Chilkat 11.7.0 · delphix · Gzip · CompressFile2 · method`

```pascal
function CompressFile2(srcPath: WideString; embeddedFilename: WideString; destPath: WideString): Integer;
```

Compresses a file and writes the result as a Gzip file, while allowing a different filename to be embedded inside the Gzip data.

The `inFilename` parameter is the actual file on disk. The `srcPath` parameter is the filename stored in the Gzip header and may be used by extraction tools as the output filename.

Returns 1 for success, 0 for failure.

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

### Gzip.CompressFileBd

`Chilkat 11.7.0 · delphix · Gzip · CompressFileBd · method · since 11.0.0`

```pascal
function CompressFileBd(filePath: WideString; bd: IChilkatBinData): Integer;
```

Compresses a file and stores the resulting Gzip data in a `BinData` object.

The compressed output is held in memory. The maximum compressed size is 4 GB.

Returns 1 for success, 0 for failure.

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

### Gzip.CompressFileToMem

`Chilkat 11.7.0 · delphix · Gzip · CompressFileToMem · method`

```pascal
function CompressFileToMem(inFilename: WideString): OleVariant;
```

Compresses a file and returns the resulting Gzip data as a byte array.

The compressed output is held in memory and has a maximum size limit of 4 GB.

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: `CompressFileToMemAsync` — same arguments, returns a `Task` (see Async variants below).

### Gzip.CompressMemory

`Chilkat 11.7.0 · delphix · Gzip · CompressMemory · method`

```pascal
function CompressMemory(inData: OleVariant): OleVariant;
```

Compresses a byte array and returns the result as an in-memory Gzip image.

The uncompressed input data must not exceed 4 GB.

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: `CompressMemoryAsync` — same arguments, returns a `Task` (see Async variants below).

### Gzip.CompressMemToFile

`Chilkat 11.7.0 · delphix · Gzip · CompressMemToFile · method`

```pascal
function CompressMemToFile(inData: OleVariant; destPath: WideString): Integer;
```

Compresses a byte array and writes the resulting Gzip data to a file.

Returns 1 for success, 0 for failure.

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

### Gzip.CompressSb

`Chilkat 11.7.0 · delphix · Gzip · CompressSb · method · since 11.0.0`

```pascal
function CompressSb(sb: IChilkatStringBuilder; charset: WideString; bd: IChilkatBinData): Integer;
```

Compresses the text contained in a `StringBuilder` and writes the Gzip-compressed result to a `BinData` object.

Before compression, the string is converted to bytes using the specified character set, such as `utf-8`, `iso-8859-1`, or `shift_JIS`.

Returns 1 for success, 0 for failure.

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

### Gzip.CompressString

`Chilkat 11.7.0 · delphix · Gzip · CompressString · method`

```pascal
function CompressString(inStr: WideString; destCharset: WideString): OleVariant;
```

**Full documentation for this method (same in every language):** [Full List of Charset Names](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

Compresses a string and returns the Gzip-compressed data as a byte array.

The string is first converted to bytes using the character set specified by `destCharset`. Common values include `utf-8`, `iso-8859-1`, and `shift_JIS`.

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

### Gzip.CompressStringENC

`Chilkat 11.7.0 · delphix · Gzip · CompressStringENC · method`

```pascal
function CompressStringENC(inStr: WideString; charset: WideString; encoding: WideString): WideString;
```

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

Compresses a string and returns the Gzip-compressed data as an encoded string.

The input string is first converted to bytes using the specified character set. The compressed binary data is then encoded using the requested encoding, such as `base64`, `hex`, `url`, `base32`, or quoted-printable.

Returns a zero-length WideString on failure

### Gzip.CompressStringToFile

`Chilkat 11.7.0 · delphix · Gzip · CompressStringToFile · method`

```pascal
function CompressStringToFile(inStr: WideString; destCharset: WideString; destPath: WideString): Integer;
```

**Full documentation for this method (same in every language):** [Full List of Charset Names](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

Compresses a string and writes the resulting Gzip data to a file.

The string is first converted to bytes using the character set specified by `destCharset`.

Returns 1 for success, 0 for failure.

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

### Gzip.GetGzipInfo

`Chilkat 11.7.0 · delphix · Gzip · GetGzipInfo · method · since 11.5.0`

```pascal
function GetGzipInfo(filePath: WideString; json: IChilkatJsonObject): Integer;
```

Retrieves metadata stored in a Gzip file and returns the information in a `JsonObject`.

The metadata is returned using the following JSON structure:

```
{
  "extraData": "AAECAw==",
  "filename": "example.txt",
  "comment": "This is the comment"
}
```

- **filename** – the original filename embedded in the Gzip file (if present)
- **comment** – an optional descriptive comment (if present)
- **extraData** – optional additional binary data, returned as a Base64-encoded string

Any of these fields may be omitted if they were not included when the Gzip file was created.

Returns 1 for success, 0 for failure.

### Gzip.GetGzipInfoBd

`Chilkat 11.7.0 · delphix · Gzip · GetGzipInfoBd · method · since 11.5.0`

```pascal
function GetGzipInfoBd(bd: IChilkatBinData; json: IChilkatJsonObject): Integer;
```

Retrieves metadata stored in Gzip data contained within a `BinData` object and returns the information in a `JsonObject`.

The metadata is returned using the same JSON structure:

```
{
  "extraData": "AAECAw==",
  "filename": "example.txt",
  "comment": "This is the comment"
}
```

- **filename** – the original filename embedded in the Gzip data (if present)
- **comment** – an optional descriptive comment (if present)
- **extraData** – optional additional binary data, returned as a Base64-encoded string

Any of these fields may be omitted if they were not included when the Gzip data was created.

Returns 1 for success, 0 for failure.

### Gzip.IsGzip

`Chilkat 11.7.0 · delphix · Gzip · IsGzip · method · since 11.0.0`

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

Checks whether the data contained in a `BinData` object is in Gzip format.

Returns `1` if the data is Gzip-formatted, or `0` otherwise.

### Gzip.LoadTaskCaller

`Chilkat 11.7.0 · delphix · Gzip · 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.

### Gzip.SetDt

`Chilkat 11.7.0 · delphix · Gzip · SetDt · method`

```pascal
function SetDt(dt: ICkDateTime): Integer;
```

Sets the last-modified date/time to embed in the Gzip file when a `Compress*` method is called.

If no date/time is explicitly set, the current system date/time is used.

Returns 1 for success, 0 for failure.

### Gzip.SetExtraData

`Chilkat 11.7.0 · delphix · Gzip · SetExtraData · method · since 11.0.0`

```pascal
function SetExtraData(encodedData: WideString; encoding: WideString): Integer;
```

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

Sets optional extra binary data to include in the Gzip header when a `Compress*` method is called.

The data is passed as an encoded string. Supported encodings include `base64`, `hex`, `ascii`, and many others.

Returns 1 for success, 0 for failure.

### Gzip.UncompressBd

`Chilkat 11.7.0 · delphix · Gzip · UncompressBd · method · since 9.5.0.67`

```pascal
function UncompressBd(binDat: IChilkatBinData): Integer;
```

Decompresses Gzip data contained in a `BinData` object in place, replacing the compressed data with the uncompressed data.

Returns 1 for success, 0 for failure.

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

### Gzip.UncompressBdToFile

`Chilkat 11.7.0 · delphix · Gzip · UncompressBdToFile · method · since 11.0.0`

```pascal
function UncompressBdToFile(bd: IChilkatBinData; filePath: WideString): Integer;
```

Decompresses Gzip data stored in a `BinData` object and writes the result to a file.

Returns 1 for success, 0 for failure.

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

### Gzip.UncompressFile

`Chilkat 11.7.0 · delphix · Gzip · UncompressFile · method`

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

Decompresses a Gzip file and writes the result to the specified output path.

The output filename is provided by the caller. The filename embedded in the Gzip data is not used.

Returns 1 for success, 0 for failure.

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

### Gzip.UncompressFileToMem

`Chilkat 11.7.0 · delphix · Gzip · UncompressFileToMem · method`

```pascal
function UncompressFileToMem(srcPath: WideString): OleVariant;
```

Decompresses a Gzip file and returns the uncompressed data as a byte array.

The uncompressed output is held in memory and must not exceed 4 GB.

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: `UncompressFileToMemAsync` — same arguments, returns a `Task` (see Async variants below).

### Gzip.UncompressFileToString

`Chilkat 11.7.0 · delphix · Gzip · UncompressFileToString · method`

```pascal
function UncompressFileToString(srcPath: WideString; charset: WideString): WideString;
```

**Full documentation for this method (same in every language):** [List of Valid Charsets](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

Decompresses a Gzip file that contains text and returns the uncompressed text as a string.

The `charset` parameter specifies the character encoding of the uncompressed text, such as `utf-8`, `iso-8859-1`, `windows-1252`, `shift_JIS`, `big5`, etc.

Returns a zero-length WideString on failure

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

### Gzip.UncompressMemory

`Chilkat 11.7.0 · delphix · Gzip · UncompressMemory · method`

```pascal
function UncompressMemory(inData: OleVariant): OleVariant;
```

Decompresses an in-memory Gzip image and returns the uncompressed data as a byte array.

The uncompressed output is held in memory and must not exceed 4 GB.

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: `UncompressMemoryAsync` — same arguments, returns a `Task` (see Async variants below).

### Gzip.UncompressMemToFile

`Chilkat 11.7.0 · delphix · Gzip · UncompressMemToFile · method`

```pascal
function UncompressMemToFile(inData: OleVariant; destPath: WideString): Integer;
```

Decompresses an in-memory Gzip image and writes the uncompressed data to a file.

Returns 1 for success, 0 for failure.

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

### Gzip.UncompressString

`Chilkat 11.7.0 · delphix · Gzip · UncompressString · method`

```pascal
function UncompressString(inData: OleVariant; inCharset: WideString): WideString;
```

**Full documentation for this method (same in every language):** [Full List of Charset Names](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/charsets_supported_by_chilkat.md)

Decompresses Gzip-compressed data and returns the result as a string.

After decompression, the result is raw binary data (a sequence of bytes). These bytes are then interpreted as text using the specified character set (such as `utf-8`, `iso-8859-1`, etc.) to produce the final string.

Internally, Chilkat converts the byte sequence to a string by interpreting the bytes according to the specified character set. For example, if `utf-8` is specified, the bytes are treated as the UTF-8 byte representation of text and decoded into the internal string format used by the programming language.

It is important that the character set matches the one originally used when the data was compressed. If the wrong character set is used, the byte-to-text conversion may produce incorrect or unreadable characters.

Returns a zero-length WideString on failure

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

### Gzip.UncompressStringENC

`Chilkat 11.7.0 · delphix · Gzip · UncompressStringENC · method`

```pascal
function UncompressStringENC(inStr: WideString; charset: WideString; encoding: WideString): WideString;
```

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

Decompresses Gzip data provided as an encoded string and returns the uncompressed result as text.

The input string is first decoded using the specified encoding, such as `base64`, `hex`, `url`, `base32`, quoted-printable, etc. The decoded Gzip data is then decompressed and converted to text using the specified character set.

Returns a zero-length WideString on failure

### Gzip.UnTarGz

`Chilkat 11.7.0 · delphix · Gzip · UnTarGz · method`

```pascal
function UnTarGz(gzPath: WideString; destDir: WideString; bNoAbsolute: Integer): Integer;
```

Extracts a `.tar.gz` archive to a directory.

The Gzip decompression and TAR extraction are performed in streaming mode. No temporary files are created, and memory usage remains small and constant.

If `bNoAbsolute` is `1`, absolute paths in the TAR archive are not allowed. This helps protect against extracting files to unsafe locations, such as system directories.

Returns 1 for success, 0 for failure.

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

### Gzip.XfdlToXml

`Chilkat 11.7.0 · delphix · Gzip · XfdlToXml · method`

```pascal
function XfdlToXml(xfldData: WideString): WideString;
```

**Full documentation for this method (same in every language):** [More about XFDL](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/xfdl.md)

Converts encoded and compressed XFDL data to a decompressed XML string.

XFDL data is often stored in an ASCII-safe compressed form, such as `asci-gzip` or `asc-gzip`. Despite the name, this does not always mean the data is a standard `.gz` file. In some XFDL files, the compressed payload uses the raw deflate format rather than the full Gzip file format.

Chilkat automatically detects the actual encoding and compression format used by the XFDL data. It decodes the ASCII/Base64 representation, determines whether the compressed data is Gzip or deflate, decompresses it correctly, and returns the resulting XML string.

This allows applications to call `XfdlToXml` without needing to manually distinguish between XFDL variants such as Base64+Gzip and Base64+Deflate.

Returns the decoded and decompressed XML string.

**XFDL (Extensible Forms Description Language)** is an XML-based format used to define secure, interactive electronic forms—often including digital signatures and integrity protections—commonly used in government and enterprise applications.

Returns a zero-length WideString on failure

## Events and callbacks

### Gzip.AbortCheck (event)

`Chilkat 11.7.0 · delphix · Gzip · 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.gzipAbortCheck(ASender: TObject;  out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  gzip: TChilkatGzip;

begin
  gzip := TChilkatGzip.Create(Self);
  gzip.OnAbortCheck := gzipAbortCheck;
  // ...
```

### Gzip.PercentDone (event)

`Chilkat 11.7.0 · delphix · Gzip · 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.gzipPercentDone(ASender: TObject;  pctDone: Integer; out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  gzip: TChilkatGzip;

begin
  gzip := TChilkatGzip.Create(Self);
  gzip.OnPercentDone := gzipPercentDone;
  // ...
```

### Gzip.ProgressInfo (event)

`Chilkat 11.7.0 · delphix · Gzip · 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.gzipProgressInfo(ASender: TObject;  const name: WideString; const value: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  gzip: TChilkatGzip;

begin
  gzip := TChilkatGzip.Create(Self);
  gzip.OnProgressInfo := gzipProgressInfo;
  // ...
```

### Gzip.TaskCompleted (event)

`Chilkat 11.7.0 · delphix · Gzip · 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.gzipTaskCompleted(ASender: TObject;  const task: IChilkatTask);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  gzip: TChilkatGzip;

begin
  gzip := TChilkatGzip.Create(Self);
  gzip.OnTaskCompleted := gzipTaskCompleted;
  // ...
```

## 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(binDat: IChilkatBinData): IChilkatTask;
function CompressFileAsync(srcPath: WideString; destPath: WideString): IChilkatTask;
function CompressFile2Async(srcPath: WideString; embeddedFilename: WideString; destPath: WideString): IChilkatTask;
function CompressFileBdAsync(filePath: WideString; bd: IChilkatBinData): IChilkatTask;
function CompressFileToMemAsync(inFilename: WideString): IChilkatTask;
function CompressMemoryAsync(inData: OleVariant): IChilkatTask;
function CompressMemToFileAsync(inData: OleVariant; destPath: WideString): IChilkatTask;
function CompressSbAsync(sb: IChilkatStringBuilder; charset: WideString; bd: IChilkatBinData): IChilkatTask;
function CompressStringAsync(inStr: WideString; destCharset: WideString): IChilkatTask;
function CompressStringToFileAsync(inStr: WideString; destCharset: WideString; destPath: WideString): IChilkatTask;
function UncompressBdAsync(binDat: IChilkatBinData): IChilkatTask;
function UncompressBdToFileAsync(bd: IChilkatBinData; filePath: WideString): IChilkatTask;
function UncompressFileAsync(srcPath: WideString; destPath: WideString): IChilkatTask;
function UncompressFileToMemAsync(srcPath: WideString): IChilkatTask;
function UncompressFileToStringAsync(srcPath: WideString; charset: WideString): IChilkatTask;
function UncompressMemoryAsync(inData: OleVariant): IChilkatTask;
function UncompressMemToFileAsync(inData: OleVariant; destPath: WideString): IChilkatTask;
function UncompressStringAsync(inData: OleVariant; inCharset: WideString): IChilkatTask;
function UnTarGzAsync(gzPath: WideString; destDir: WideString; bNoAbsolute: Integer): IChilkatTask;
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `Decode` | method | before 11.6.1 | — |
| `DeflateStringENC` | method | before 11.6.1 | — |
| `Encode` | method | before 11.6.1 | — |
| `ExamineFile` | method | before 11.6.1 | — |
| `ExamineMemory` | method | before 11.6.1 | — |
| `GetDt` | method | before 11.6.1 | — |
| `InflateStringENC` | method | before 11.6.1 | — |
| `ReadFile` | method | before 11.6.1 | — |
| `WriteFile` | method | before 11.6.1 | — |

## Related classes

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

