---
product: Chilkat
product_version: 11.7.0
language: xojo
language_label: Xojo
class: Gzip
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/xojoGzipRef.html
---
# Chilkat Gzip — Xojo — v11.7.0

> Chilkat 11.7.0 · language=xojo · class=Gzip
> 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/xojo/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**

```xojo
Dim gzip As New Chilkat.Gzip
```

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

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. |
| `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 Boolean` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `VerboseLogging As Boolean` | read/write | If set to `True`, 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 |
|---|---|---|
| `AbortCurrent` | property, read/write | `AbortCurrent As Boolean` |
| `Comment` | property, read/write | `Comment As String` |
| `CompressionLevel` | property, read/write | `CompressionLevel As Int32` |
| `Filename` | property, read/write | `Filename As String` |
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Int32` |
| `LastModStr` | property, read/write | `LastModStr As String` |
| `UseCurrentDate` | property, read/write | `UseCurrentDate As Boolean` |
| `CompressBd` | method | `Function CompressBd(binDat As Chilkat.BinData) As Boolean` |
| `CompressFile` | method | `Function CompressFile(srcPath As String, destPath As String) As Boolean` |
| `CompressFile2` | method | `Function CompressFile2(srcPath As String, embeddedFilename As String, destPath As String) As Boolean` |
| `CompressFileBd` | method | `Function CompressFileBd(filePath As String, bd As Chilkat.BinData) As Boolean` |
| `CompressFileToMem` | method | `Function CompressFileToMem(inFilename As String) As MemoryBlock` |
| `CompressMemory` | method | `Function CompressMemory(inData As MemoryBlock) As MemoryBlock` |
| `CompressMemToFile` | method | `Function CompressMemToFile(inData As MemoryBlock, destPath As String) As Boolean` |
| `CompressSb` | method | `Function CompressSb(sb As Chilkat.StringBuilder, charset As String, bd As Chilkat.BinData) As Boolean` |
| `CompressString` | method | `Function CompressString(inStr As String, destCharset As String) As MemoryBlock` |
| `CompressStringENC` | method | `Function CompressStringENC(inStr As String, charset As String, encoding As String) As String` |
| `CompressStringToFile` | method | `Function CompressStringToFile(inStr As String, destCharset As String, destPath As String) As Boolean` |
| `GetGzipInfo` | method | `Function GetGzipInfo(filePath As String, json As Chilkat.JsonObject) As Boolean` |
| `GetGzipInfoBd` | method | `Function GetGzipInfoBd(bd As Chilkat.BinData, json As Chilkat.JsonObject) As Boolean` |
| `IsGzip` | method | `Function IsGzip(bd As Chilkat.BinData) As Boolean` |
| `LoadTaskCaller` | method | `Function LoadTaskCaller(task As Chilkat.Task) As Boolean` |
| `SetDt` | method | `Function SetDt(dt As Chilkat.CkDateTime) As Boolean` |
| `SetExtraData` | method | `Function SetExtraData(encodedData As String, encoding As String) As Boolean` |
| `UncompressBd` | method | `Function UncompressBd(binDat As Chilkat.BinData) As Boolean` |
| `UncompressBdToFile` | method | `Function UncompressBdToFile(bd As Chilkat.BinData, filePath As String) As Boolean` |
| `UncompressFile` | method | `Function UncompressFile(srcPath As String, destPath As String) As Boolean` |
| `UncompressFileToMem` | method | `Function UncompressFileToMem(srcPath As String) As MemoryBlock` |
| `UncompressFileToString` | method | `Function UncompressFileToString(srcPath As String, charset As String) As String` |
| `UncompressMemory` | method | `Function UncompressMemory(inData As MemoryBlock) As MemoryBlock` |
| `UncompressMemToFile` | method | `Function UncompressMemToFile(inData As MemoryBlock, destPath As String) As Boolean` |
| `UncompressString` | method | `Function UncompressString(inData As MemoryBlock, inCharset As String) As String` |
| `UncompressStringENC` | method | `Function UncompressStringENC(inStr As String, charset As String, encoding As String) As String` |
| `UnTarGz` | method | `Function UnTarGz(gzPath As String, destDir As String, bNoAbsolute As Boolean) As Boolean` |
| `XfdlToXml` | method | `Function XfdlToXml(xfldData As String) As String` |

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 · xojo · Gzip · AbortCurrent · property · read/write · since 9.5.0.58`

```xojo
AbortCurrent As Boolean
```

Set this property to `True` 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 `False` when the next method begins. After an abort occurs, it is also reset to `False`. Both synchronous and asynchronous operations can be aborted. For synchronous calls, another thread must set this property.

### Gzip.Comment

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

```xojo
Comment As String
```

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

### Gzip.CompressionLevel

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

```xojo
CompressionLevel As Int32
```

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

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

```xojo
Filename As String
```

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 · xojo · Gzip · HeartbeatMs · property · read/write`

```xojo
HeartbeatMs As Int32
```

**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 · xojo · Gzip · LastModStr · property · read/write`

```xojo
LastModStr As String
```

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 · xojo · Gzip · UseCurrentDate · property · read/write`

```xojo
UseCurrentDate As Boolean
```

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

When set to `True`, 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 · xojo · Gzip · CompressBd · method · since 9.5.0.67`

```xojo
Function CompressBd(binDat As Chilkat.BinData) As Boolean
```

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

Returns True for success, False for failure.

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

### Gzip.CompressFile

`Chilkat 11.7.0 · xojo · Gzip · CompressFile · method`

```xojo
Function CompressFile(srcPath As String, destPath As String) As Boolean
```

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

Returns True for success, False for failure.

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

### Gzip.CompressFile2

`Chilkat 11.7.0 · xojo · Gzip · CompressFile2 · method`

```xojo
Function CompressFile2(srcPath As String, embeddedFilename As String, destPath As String) As Boolean
```

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 True for success, False for failure.

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

### Gzip.CompressFileBd

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

```xojo
Function CompressFileBd(filePath As String, bd As Chilkat.BinData) As Boolean
```

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 True for success, False for failure.

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

### Gzip.CompressFileToMem

`Chilkat 11.7.0 · xojo · Gzip · CompressFileToMem · method`

```xojo
Function CompressFileToMem(inFilename As String) As MemoryBlock
```

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 `Nil` on failure

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

### Gzip.CompressMemory

`Chilkat 11.7.0 · xojo · Gzip · CompressMemory · method`

```xojo
Function CompressMemory(inData As MemoryBlock) As MemoryBlock
```

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

The uncompressed input data must not exceed 4 GB.

Returns `Nil` on failure

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

### Gzip.CompressMemToFile

`Chilkat 11.7.0 · xojo · Gzip · CompressMemToFile · method`

```xojo
Function CompressMemToFile(inData As MemoryBlock, destPath As String) As Boolean
```

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

Returns True for success, False for failure.

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

### Gzip.CompressSb

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

```xojo
Function CompressSb(sb As Chilkat.StringBuilder, charset As String, bd As Chilkat.BinData) As Boolean
```

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 True for success, False for failure.

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

### Gzip.CompressString

`Chilkat 11.7.0 · xojo · Gzip · CompressString · method`

```xojo
Function CompressString(inStr As String, destCharset As String) As MemoryBlock
```

**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 `Nil` on failure

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

### Gzip.CompressStringENC

`Chilkat 11.7.0 · xojo · Gzip · CompressStringENC · method`

```xojo
Function CompressStringENC(inStr As String, charset As String, encoding As String) As String
```

**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 `Nil` on failure

### Gzip.CompressStringToFile

`Chilkat 11.7.0 · xojo · Gzip · CompressStringToFile · method`

```xojo
Function CompressStringToFile(inStr As String, destCharset As String, destPath As String) As Boolean
```

**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 True for success, False for failure.

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

### Gzip.GetGzipInfo

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

```xojo
Function GetGzipInfo(filePath As String, json As Chilkat.JsonObject) As Boolean
```

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 True for success, False for failure.

### Gzip.GetGzipInfoBd

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

```xojo
Function GetGzipInfoBd(bd As Chilkat.BinData, json As Chilkat.JsonObject) As Boolean
```

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 True for success, False for failure.

### Gzip.IsGzip

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

```xojo
Function IsGzip(bd As Chilkat.BinData) As Boolean
```

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

Returns `True` if the data is Gzip-formatted, or `False` otherwise.

### Gzip.LoadTaskCaller

`Chilkat 11.7.0 · xojo · Gzip · LoadTaskCaller · method · since 9.5.0.80`

```xojo
Function LoadTaskCaller(task As Chilkat.Task) As Boolean
```

Loads the caller of the task's async method.

Returns True for success, False for failure.

### Gzip.SetDt

`Chilkat 11.7.0 · xojo · Gzip · SetDt · method`

```xojo
Function SetDt(dt As Chilkat.CkDateTime) As Boolean
```

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 True for success, False for failure.

### Gzip.SetExtraData

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

```xojo
Function SetExtraData(encodedData As String, encoding As String) As Boolean
```

**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 True for success, False for failure.

### Gzip.UncompressBd

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

```xojo
Function UncompressBd(binDat As Chilkat.BinData) As Boolean
```

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

Returns True for success, False for failure.

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

### Gzip.UncompressBdToFile

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

```xojo
Function UncompressBdToFile(bd As Chilkat.BinData, filePath As String) As Boolean
```

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

Returns True for success, False for failure.

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

### Gzip.UncompressFile

`Chilkat 11.7.0 · xojo · Gzip · UncompressFile · method`

```xojo
Function UncompressFile(srcPath As String, destPath As String) As Boolean
```

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 True for success, False for failure.

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

### Gzip.UncompressFileToMem

`Chilkat 11.7.0 · xojo · Gzip · UncompressFileToMem · method`

```xojo
Function UncompressFileToMem(srcPath As String) As MemoryBlock
```

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 `Nil` on failure

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

### Gzip.UncompressFileToString

`Chilkat 11.7.0 · xojo · Gzip · UncompressFileToString · method`

```xojo
Function UncompressFileToString(srcPath As String, charset As String) As String
```

**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 `Nil` on failure

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

### Gzip.UncompressMemory

`Chilkat 11.7.0 · xojo · Gzip · UncompressMemory · method`

```xojo
Function UncompressMemory(inData As MemoryBlock) As MemoryBlock
```

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 `Nil` on failure

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

### Gzip.UncompressMemToFile

`Chilkat 11.7.0 · xojo · Gzip · UncompressMemToFile · method`

```xojo
Function UncompressMemToFile(inData As MemoryBlock, destPath As String) As Boolean
```

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

Returns True for success, False for failure.

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

### Gzip.UncompressString

`Chilkat 11.7.0 · xojo · Gzip · UncompressString · method`

```xojo
Function UncompressString(inData As MemoryBlock, inCharset As String) As String
```

**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 `Nil` on failure

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

### Gzip.UncompressStringENC

`Chilkat 11.7.0 · xojo · Gzip · UncompressStringENC · method`

```xojo
Function UncompressStringENC(inStr As String, charset As String, encoding As String) As String
```

**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 `Nil` on failure

### Gzip.UnTarGz

`Chilkat 11.7.0 · xojo · Gzip · UnTarGz · method`

```xojo
Function UnTarGz(gzPath As String, destDir As String, bNoAbsolute As Boolean) As Boolean
```

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 `True`, absolute paths in the TAR archive are not allowed. This helps protect against extracting files to unsafe locations, such as system directories.

Returns True for success, False for failure.

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

### Gzip.XfdlToXml

`Chilkat 11.7.0 · xojo · Gzip · XfdlToXml · method`

```xojo
Function XfdlToXml(xfldData As String) As String
```

**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 `Nil` on failure

## Events and callbacks

In Xojo, Chilkat events are handled by subclassing. Add a new class to your project that inherits from Chilkat.Gzip, then override the event methods you want to respond to. Any method you don't override keeps its default do-nothing behavior, so you only need to write the ones you actually care about.

From that point on, create and use an instance of your subclass wherever you would have used a Chilkat.Gzip. The events fire on your instance automatically as the object does its work.

**For example:**

```vb
class MyGzip
    Inherits Chilkat.Gzip

    Function AbortCheck() As Boolean
    Function PercentDone(pctDone As Int32) As Boolean
    Sub ProgressInfo(name As String, value As String)
    Sub TaskCompleted(task As Chilkat.Task)

End Class
```

### Gzip.AbortCheck (event)

`Chilkat 11.7.0 · xojo · Gzip · AbortCheck · event`

```xojo
Function AbortCheck() As Boolean
```

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.

### Gzip.PercentDone (event)

`Chilkat 11.7.0 · xojo · Gzip · PercentDone · event`

```xojo
Function PercentDone(pctDone As Int32) As Boolean
```

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the `abort` output argument to `True`. This will cause the method to terminate and return a failure status or corresponding failure value.

### Gzip.ProgressInfo (event)

`Chilkat 11.7.0 · xojo · Gzip · ProgressInfo · event`

```xojo
Sub 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.

### Gzip.TaskCompleted (event)

`Chilkat 11.7.0 · xojo · Gzip · TaskCompleted · event`

```xojo
Sub TaskCompleted(task As Chilkat.Task)
```

Called from the background thread when an asynchronous task completes.

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

```xojo
Function CompressBdAsync(binDat As Chilkat.BinData) As Chilkat.Task
Function CompressFileAsync(srcPath As String, destPath As String) As Chilkat.Task
Function CompressFile2Async(srcPath As String, embeddedFilename As String, destPath As String) As Chilkat.Task
Function CompressFileBdAsync(filePath As String, bd As Chilkat.BinData) As Chilkat.Task
Function CompressFileToMemAsync(inFilename As String) As Chilkat.Task
Function CompressMemoryAsync(inData As MemoryBlock) As Chilkat.Task
Function CompressMemToFileAsync(inData As MemoryBlock, destPath As String) As Chilkat.Task
Function CompressSbAsync(sb As Chilkat.StringBuilder, charset As String, bd As Chilkat.BinData) As Chilkat.Task
Function CompressStringAsync(inStr As String, destCharset As String) As Chilkat.Task
Function CompressStringToFileAsync(inStr As String, destCharset As String, destPath As String) As Chilkat.Task
Function UncompressBdAsync(binDat As Chilkat.BinData) As Chilkat.Task
Function UncompressBdToFileAsync(bd As Chilkat.BinData, filePath As String) As Chilkat.Task
Function UncompressFileAsync(srcPath As String, destPath As String) As Chilkat.Task
Function UncompressFileToMemAsync(srcPath As String) As Chilkat.Task
Function UncompressFileToStringAsync(srcPath As String, charset As String) As Chilkat.Task
Function UncompressMemoryAsync(inData As MemoryBlock) As Chilkat.Task
Function UncompressMemToFileAsync(inData As MemoryBlock, destPath As String) As Chilkat.Task
Function UncompressStringAsync(inData As MemoryBlock, inCharset As String) As Chilkat.Task
Function UnTarGzAsync(gzPath As String, destDir As String, bNoAbsolute As Boolean) As Chilkat.Task
```

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

