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

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

```tcl
# 'this' is not a keyword in Tcl. It can freely be used as a variable name.
set this [new CkGzip]
```

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

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` | `string # ckStr is a CkString CkGzip_get_DebugLogFilePath $this $ckStr set strVal [CkGzip_get_debugLogFilePath $this] CkGzip_put_DebugLogFilePath $this $strVal` | 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` | `string # ckStr is a CkString CkGzip_get_LastErrorHtml $this $ckStr set strVal [CkGzip_get_lastErrorHtml $this]` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `string # ckStr is a CkString CkGzip_get_LastErrorText $this $ckStr set strVal [CkGzip_get_lastErrorText $this]` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `string # ckStr is a CkString CkGzip_get_LastErrorXml $this $ckStr set strVal [CkGzip_get_lastErrorXml $this]` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `boolean 1/0 set boolVal [CkGzip_get_LastMethodSuccess $this] CkGzip_put_LastMethodSuccess $this $boolVal` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `Utf8` | `boolean 1/0 set boolVal [CkGzip_get_Utf8 $this] CkGzip_put_Utf8 $this $boolVal` | read/write | When set to `1`, all `string` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `boolean 1/0 set boolVal [CkGzip_get_VerboseLogging $this] CkGzip_put_VerboseLogging $this $boolVal` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `string # ckStr is a CkString CkGzip_get_Version $this $ckStr set strVal [CkGzip_get_version $this]` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `boolean 1/0 set boolVal [CkGzip_get_AbortCurrent $this] CkGzip_put_AbortCurrent $this $boolVal` |
| `Comment` | property, read/write | `string # ckStr is a CkString CkGzip_get_Comment $this $ckStr set strVal [CkGzip_get_comment $this] CkGzip_put_Comment $this $strVal` |
| `CompressionLevel` | property, read/write | `integer set intVal [CkGzip_get_CompressionLevel $this] CkGzip_put_CompressionLevel $this $intVal` |
| `Filename` | property, read/write | `string # ckStr is a CkString CkGzip_get_Filename $this $ckStr set strVal [CkGzip_get_filename $this] CkGzip_put_Filename $this $strVal` |
| `LastModStr` | property, read/write | `string # ckStr is a CkString CkGzip_get_LastModStr $this $ckStr set strVal [CkGzip_get_lastModStr $this] CkGzip_put_LastModStr $this $strVal` |
| `UseCurrentDate` | property, read/write | `boolean 1/0 set boolVal [CkGzip_get_UseCurrentDate $this] CkGzip_put_UseCurrentDate $this $boolVal` |
| `CompressBd` | method | `# binDat is a CkBinData set status [CkGzip_CompressBd $this $binDat]` |
| `CompressFile` | method | `# srcPath is a string # destPath is a string set status [CkGzip_CompressFile $this $srcPath $destPath]` |
| `CompressFile2` | method | `# srcPath is a string # embeddedFilename is a string # destPath is a string set status [CkGzip_CompressFile2 $this $srcPath $embeddedFilename $destPath]` |
| `CompressFileBd` | method | `# filePath is a string # bd is a CkBinData set status [CkGzip_CompressFileBd $this $filePath $bd]` |
| `CompressSb` | method | `# sb is a CkStringBuilder # charset is a string # bd is a CkBinData set status [CkGzip_CompressSb $this $sb $charset $bd]` |
| `CompressStringENC` | method | `# inStr is a string # charset is a string # encoding is a string # outStr is a CkString (output) set status [CkGzip_CompressStringENC $this $inStr $charset $encoding $outStr] set retStr [CkGzip_compressStringENC $this $inStr $charset $encoding]` |
| `CompressStringToFile` | method | `# inStr is a string # destCharset is a string # destPath is a string set status [CkGzip_CompressStringToFile $this $inStr $destCharset $destPath]` |
| `GetGzipInfo` | method | `# filePath is a string # json is a CkJsonObject set status [CkGzip_GetGzipInfo $this $filePath $json]` |
| `GetGzipInfoBd` | method | `# bd is a CkBinData # json is a CkJsonObject set status [CkGzip_GetGzipInfoBd $this $bd $json]` |
| `IsGzip` | method | `# bd is a CkBinData set retBool [CkGzip_IsGzip $this $bd]` |
| `LoadTaskCaller` | method | `# task is a CkTask set status [CkGzip_LoadTaskCaller $this $task]` |
| `SetDt` | method | `# dt is a CkDateTime set status [CkGzip_SetDt $this $dt]` |
| `SetExtraData` | method | `# encodedData is a string # encoding is a string set status [CkGzip_SetExtraData $this $encodedData $encoding]` |
| `UncompressBd` | method | `# binDat is a CkBinData set status [CkGzip_UncompressBd $this $binDat]` |
| `UncompressBdToFile` | method | `# bd is a CkBinData # filePath is a string set status [CkGzip_UncompressBdToFile $this $bd $filePath]` |
| `UncompressFile` | method | `# srcPath is a string # destPath is a string set status [CkGzip_UncompressFile $this $srcPath $destPath]` |
| `UncompressFileToString` | method | `# srcPath is a string # charset is a string # outStr is a CkString (output) set status [CkGzip_UncompressFileToString $this $srcPath $charset $outStr] set retStr [CkGzip_uncompressFileToString $this $srcPath $charset]` |
| `UncompressStringENC` | method | `# inStr is a string # charset is a string # encoding is a string # outStr is a CkString (output) set status [CkGzip_UncompressStringENC $this $inStr $charset $encoding $outStr] set retStr [CkGzip_uncompressStringENC $this $inStr $charset $encoding]` |
| `UnTarGz` | method | `# gzPath is a string # destDir is a string # bNoAbsolute is a boolean set status [CkGzip_UnTarGz $this $gzPath $destDir $bNoAbsolute]` |
| `XfdlToXml` | method | `# xfldData is a string # outStr is a CkString (output) set status [CkGzip_XfdlToXml $this $xfldData $outStr] set retStr [CkGzip_xfdlToXml $this $xfldData]` |

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

```tcl
boolean 1/0
set boolVal [CkGzip_get_AbortCurrent $this]

CkGzip_put_AbortCurrent $this $boolVal
```

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 · tcl · Gzip · Comment · property · read/write`

```tcl
string
# ckStr is a CkString

CkGzip_get_Comment $this $ckStr

set strVal [CkGzip_get_comment $this]

CkGzip_put_Comment $this $strVal
```

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

### Gzip.CompressionLevel

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

```tcl
integer
set intVal [CkGzip_get_CompressionLevel $this]

CkGzip_put_CompressionLevel $this $intVal
```

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 · tcl · Gzip · Filename · property · read/write`

```tcl
string
# ckStr is a CkString

CkGzip_get_Filename $this $ckStr

set strVal [CkGzip_get_filename $this]

CkGzip_put_Filename $this $strVal
```

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

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

```tcl
string
# ckStr is a CkString

CkGzip_get_LastModStr $this $ckStr

set strVal [CkGzip_get_lastModStr $this]

CkGzip_put_LastModStr $this $strVal
```

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

```tcl
boolean 1/0
set boolVal [CkGzip_get_UseCurrentDate $this]

CkGzip_put_UseCurrentDate $this $boolVal
```

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 · tcl · Gzip · CompressBd · method · since 9.5.0.67`

```tcl
# binDat is a CkBinData

set status [CkGzip_CompressBd $this $binDat]
```

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 · tcl · Gzip · CompressFile · method`

```tcl
# srcPath is a string

# destPath is a string

set status [CkGzip_CompressFile $this $srcPath  $destPath]
```

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 · tcl · Gzip · CompressFile2 · method`

```tcl
# srcPath is a string

# embeddedFilename is a string

# destPath is a string

set status [CkGzip_CompressFile2 $this $srcPath  $embeddedFilename  $destPath]
```

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 · tcl · Gzip · CompressFileBd · method · since 11.0.0`

```tcl
# filePath is a string

# bd is a CkBinData

set status [CkGzip_CompressFileBd $this $filePath  $bd]
```

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

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

```tcl
# sb is a CkStringBuilder

# charset is a string

# bd is a CkBinData

set status [CkGzip_CompressSb $this $sb  $charset  $bd]
```

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

`Chilkat 11.7.0 · tcl · Gzip · CompressStringENC · method`

```tcl
# inStr is a string

# charset is a string

# encoding is a string

# outStr is a CkString (output)

set status [CkGzip_CompressStringENC $this $inStr  $charset  $encoding $outStr]

set retStr [CkGzip_compressStringENC $this $inStr $charset $encoding]
```

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

### Gzip.CompressStringToFile

`Chilkat 11.7.0 · tcl · Gzip · CompressStringToFile · method`

```tcl
# inStr is a string

# destCharset is a string

# destPath is a string

set status [CkGzip_CompressStringToFile $this $inStr  $destCharset  $destPath]
```

**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 · tcl · Gzip · GetGzipInfo · method · since 11.5.0`

```tcl
# filePath is a string

# json is a CkJsonObject

set status [CkGzip_GetGzipInfo $this $filePath  $json]
```

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 · tcl · Gzip · GetGzipInfoBd · method · since 11.5.0`

```tcl
# bd is a CkBinData

# json is a CkJsonObject

set status [CkGzip_GetGzipInfoBd $this $bd  $json]
```

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 · tcl · Gzip · IsGzip · method · since 11.0.0`

```tcl
# bd is a CkBinData

set retBool [CkGzip_IsGzip $this $bd]
```

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 · tcl · Gzip · LoadTaskCaller · method · since 9.5.0.80`

```tcl
# task is a CkTask

set status [CkGzip_LoadTaskCaller $this $task]
```

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

### Gzip.SetDt

`Chilkat 11.7.0 · tcl · Gzip · SetDt · method`

```tcl
# dt is a CkDateTime

set status [CkGzip_SetDt $this $dt]
```

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 · tcl · Gzip · SetExtraData · method · since 11.0.0`

```tcl
# encodedData is a string

# encoding is a string

set status [CkGzip_SetExtraData $this $encodedData  $encoding]
```

**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 · tcl · Gzip · UncompressBd · method · since 9.5.0.67`

```tcl
# binDat is a CkBinData

set status [CkGzip_UncompressBd $this $binDat]
```

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 · tcl · Gzip · UncompressBdToFile · method · since 11.0.0`

```tcl
# bd is a CkBinData

# filePath is a string

set status [CkGzip_UncompressBdToFile $this $bd  $filePath]
```

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 · tcl · Gzip · UncompressFile · method`

```tcl
# srcPath is a string

# destPath is a string

set status [CkGzip_UncompressFile $this $srcPath  $destPath]
```

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

`Chilkat 11.7.0 · tcl · Gzip · UncompressFileToString · method`

```tcl
# srcPath is a string

# charset is a string

# outStr is a CkString (output)

set status [CkGzip_UncompressFileToString $this $srcPath  $charset $outStr]

set retStr [CkGzip_uncompressFileToString $this $srcPath $charset]
```

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

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

### Gzip.UncompressStringENC

`Chilkat 11.7.0 · tcl · Gzip · UncompressStringENC · method`

```tcl
# inStr is a string

# charset is a string

# encoding is a string

# outStr is a CkString (output)

set status [CkGzip_UncompressStringENC $this $inStr  $charset  $encoding $outStr]

set retStr [CkGzip_uncompressStringENC $this $inStr $charset $encoding]
```

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

### Gzip.UnTarGz

`Chilkat 11.7.0 · tcl · Gzip · UnTarGz · method`

```tcl
# gzPath is a string

# destDir is a string

# bNoAbsolute is a boolean

set status [CkGzip_UnTarGz $this $gzPath  $destDir  $bNoAbsolute]
```

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 · tcl · Gzip · XfdlToXml · method`

```tcl
# xfldData is a string

# outStr is a CkString (output)

set status [CkGzip_XfdlToXml $this $xfldData $outStr]

set retStr [CkGzip_xfdlToXml $this $xfldData]
```

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

## Events and callbacks

This binding has no event callbacks. For progress, percent-done or cancellation use the `*Async` variant of a method and poll the returned `Task` (`PercentDone`, `Finished`, `Cancel`).

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

```tcl
# returns a CkTask

# binDat is a CkBinData

set ret_task [CkGzip_CompressBdAsync $this $binDat]
# returns a CkTask

# srcPath is a string

# destPath is a string

set ret_task [CkGzip_CompressFileAsync $this $srcPath  $destPath]
# returns a CkTask

# srcPath is a string

# embeddedFilename is a string

# destPath is a string

set ret_task [CkGzip_CompressFile2Async $this $srcPath  $embeddedFilename  $destPath]
# returns a CkTask

# filePath is a string

# bd is a CkBinData

set ret_task [CkGzip_CompressFileBdAsync $this $filePath  $bd]
# returns a CkTask

# sb is a CkStringBuilder

# charset is a string

# bd is a CkBinData

set ret_task [CkGzip_CompressSbAsync $this $sb  $charset  $bd]
# returns a CkTask

# inStr is a string

# destCharset is a string

# destPath is a string

set ret_task [CkGzip_CompressStringToFileAsync $this $inStr  $destCharset  $destPath]
# returns a CkTask

# binDat is a CkBinData

set ret_task [CkGzip_UncompressBdAsync $this $binDat]
# returns a CkTask

# bd is a CkBinData

# filePath is a string

set ret_task [CkGzip_UncompressBdToFileAsync $this $bd  $filePath]
# returns a CkTask

# srcPath is a string

# destPath is a string

set ret_task [CkGzip_UncompressFileAsync $this $srcPath  $destPath]
# returns a CkTask

# srcPath is a string

# charset is a string

set ret_task [CkGzip_UncompressFileToStringAsync $this $srcPath  $charset]
# returns a CkTask

# gzPath is a string

# destDir is a string

# bNoAbsolute is a boolean

set ret_task [CkGzip_UnTarGzAsync $this $gzPath  $destDir  $bNoAbsolute]
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `CompressFileToMem` | method | before 11.6.1 | — |
| `CompressMemory` | method | before 11.6.1 | — |
| `CompressMemToFile` | method | before 11.6.1 | — |
| `CompressString` | method | before 11.6.1 | — |
| `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 | — |
| `UncompressFileToMem` | method | before 11.6.1 | — |
| `UncompressMemory` | method | before 11.6.1 | — |
| `UncompressMemToFile` | method | before 11.6.1 | — |
| `UncompressString` | method | before 11.6.1 | — |
| `WriteFile` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/BinData.md), [`CkDateTime`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/CkDateTime.md), [`JsonObject`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/JsonObject.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/tcl/classes/Task.md)

