---
product: Chilkat
product_version: 11.7.0
language: wc
language_label: Unicode C
class: UnixCompress
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/wc_CkUnixCompressWRef.html
---
# Chilkat UnixCompress — Unicode C — v11.7.0

> Chilkat 11.7.0 · language=wc · class=UnixCompress
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/UnixCompress.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/guide.md`.

## Purpose

**Compress, uncompress, and unpack legacy UNIX `.Z` files.**

`Chilkat.UnixCompress` provides UNIX `compress` and `uncompress` functionality for legacy `.Z` files. It supports file-based, memory-based, and string-based workflows, uses LZW compression, can unpack `.tar.Z` archives, and includes abort and progress-related support for longer-running operations.

**Compress to .Z**

Compress files, memory data, or strings into UNIX `.Z` format using LZW compression.

**Uncompress .Z data**

Expand UNIX-compressed data back to files, memory, byte arrays, or text depending on the application workflow.

**File workflows**

Compress and uncompress directly between input and output files when working with existing filesystem data.

**Memory workflows**

Work with compressed or uncompressed byte data in memory when temporary files are not desired.

**String workflows**

Compress and uncompress text using an explicit character set so string data round-trips correctly.

**Unpack tar.Z archives**

Use `UnTarZ` to decompress and extract legacy `.tar.Z` archives in a single workflow.

**Common pattern:** Use `UnixCompress` when the data is in classic UNIX `.Z` format or when a `.tar.Z` archive must be unpacked. Use `Chilkat.Gzip` for `.gz` and `.tar.gz` files, `Chilkat.Bz2` for `.bz2` files, and `Chilkat.Compression` for raw compression algorithms and general-purpose compression workflows.

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

## Object creation, unlocking and error handling

**Create/Dispose**

```c
HCkUnixCompressW instance = CkUnixCompressW_Create();
// ...
CkUnixCompressW_Dispose(instance);
```

`HCkUnixCompressW CkUnixCompressW_Create(void);`

Creates an instance of the HCkUnixCompressW object and returns a handle ("void \*" pointer). The handle is passed in the 1st argument for the functions listed on this page.

`void CkUnixCompressW_Dispose(HCkUnixCompressW handle);`

Objects created by calling CkUnixCompressW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkUnixCompressW_Dispose.

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 Unicode C.

## 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` | `void CkUnixCompressW_getDebugLogFilePath(HCkUnixCompressW cHandle, HCkString retval); void CkUnixCompressW_putDebugLogFilePath(HCkUnixCompressW cHandle, const wchar_t *newVal); const wchar_t *CkUnixCompressW_debugLogFilePath(HCkUnixCompressW cHandle);` | 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` | `void CkUnixCompressW_getLastErrorHtml(HCkUnixCompressW cHandle, HCkString retval); const wchar_t *CkUnixCompressW_lastErrorHtml(HCkUnixCompressW cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkUnixCompressW_getLastErrorText(HCkUnixCompressW cHandle, HCkString retval); const wchar_t *CkUnixCompressW_lastErrorText(HCkUnixCompressW cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkUnixCompressW_getLastErrorXml(HCkUnixCompressW cHandle, HCkString retval); const wchar_t *CkUnixCompressW_lastErrorXml(HCkUnixCompressW cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkUnixCompressW_getLastMethodSuccess(HCkUnixCompressW cHandle); void CkUnixCompressW_putLastMethodSuccess(HCkUnixCompressW cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `VerboseLogging` | `BOOL CkUnixCompressW_getVerboseLogging(HCkUnixCompressW cHandle); void CkUnixCompressW_putVerboseLogging(HCkUnixCompressW cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkUnixCompressW_getVersion(HCkUnixCompressW cHandle, HCkString retval); const wchar_t *CkUnixCompressW_version(HCkUnixCompressW cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `BOOL CkUnixCompressW_getAbortCurrent(HCkUnixCompressW cHandle); void CkUnixCompressW_putAbortCurrent(HCkUnixCompressW cHandle, BOOL newVal);` |
| `HeartbeatMs` | property, read/write | `int CkUnixCompressW_getHeartbeatMs(HCkUnixCompressW cHandle); void CkUnixCompressW_putHeartbeatMs(HCkUnixCompressW cHandle, int newVal);` |
| `CompressFile` | method | `BOOL CkUnixCompressW_CompressFile(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);` |
| `CompressStringToFile` | method | `BOOL CkUnixCompressW_CompressStringToFile(HCkUnixCompressW cHandle, const wchar_t *inStr, const wchar_t *charset, const wchar_t *destPath);` |
| `LoadTaskCaller` | method | `BOOL CkUnixCompressW_LoadTaskCaller(HCkUnixCompressW cHandle, HCkTaskW task);` |
| `UncompressFile` | method | `BOOL CkUnixCompressW_UncompressFile(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);` |
| `UncompressFileToString` | method | `BOOL CkUnixCompressW_UncompressFileToString(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *charset, const wchar_t *outStr); const wchar_t *CkUnixCompressW_uncompressFileToString(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *charset);` |
| `UnTarZ` | method | `BOOL CkUnixCompressW_UnTarZ(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *destDir, BOOL bNoAbsolute);` |

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

## Properties

### UnixCompress.AbortCurrent

`Chilkat 11.7.0 · wc · UnixCompress · AbortCurrent · property · read/write · since 9.5.0.58`

```c
BOOL CkUnixCompressW_getAbortCurrent(HCkUnixCompressW cHandle);
void CkUnixCompressW_putAbortCurrent(HCkUnixCompressW cHandle, BOOL newVal);
```

When set to `TRUE`, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to `FALSE` when the next method is called. When the abort occurs, this property is reset to `FALSE`. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

### UnixCompress.HeartbeatMs

`Chilkat 11.7.0 · wc · UnixCompress · HeartbeatMs · property · read/write`

```c
int CkUnixCompressW_getHeartbeatMs(HCkUnixCompressW cHandle);
void CkUnixCompressW_putHeartbeatMs(HCkUnixCompressW cHandle, int newVal);
```

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

The interval in milliseconds between each `AbortCheck` event callback, which enables an application to abort certain method calls before they complete. **By default, HeartbeatMs is set to** `0`**, meaning no AbortCheck event callbacks will trigger.**

## Methods

### UnixCompress.CompressFile

`Chilkat 11.7.0 · wc · UnixCompress · CompressFile · method`

```c
BOOL CkUnixCompressW_CompressFile(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);
```

Compresses a file to create a UNIX compressed file (.Z). This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.

Returns TRUE for success, FALSE for failure.

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

### UnixCompress.CompressStringToFile

`Chilkat 11.7.0 · wc · UnixCompress · CompressStringToFile · method`

```c
BOOL CkUnixCompressW_CompressStringToFile(HCkUnixCompressW cHandle, const wchar_t *inStr, const wchar_t *charset, const wchar_t *destPath);
```

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

Unix compresses and creates a .Z file from string data. The `charset` specifies the character encoding used for the byte representation of the characters when compressed. The `charset` can be any one of a large number of character encodings, such as `utf-8`, `iso-8859-1`, `Windows-1252`, `ucs-2`, etc.

Returns TRUE for success, FALSE for failure.

### UnixCompress.LoadTaskCaller

`Chilkat 11.7.0 · wc · UnixCompress · LoadTaskCaller · method · since 9.5.0.80`

```c
BOOL CkUnixCompressW_LoadTaskCaller(HCkUnixCompressW cHandle, HCkTaskW task);
```

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

### UnixCompress.UncompressFile

`Chilkat 11.7.0 · wc · UnixCompress · UncompressFile · method`

```c
BOOL CkUnixCompressW_UncompressFile(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);
```

Uncompresses a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns TRUE for success, FALSE for failure.

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

### UnixCompress.UncompressFileToString

`Chilkat 11.7.0 · wc · UnixCompress · UncompressFileToString · method`

```c
BOOL CkUnixCompressW_UncompressFileToString(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *charset, const wchar_t *outStr);
const wchar_t *CkUnixCompressW_uncompressFileToString(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *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)

Uncompresses a .Z file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by `charset`. Typical charsets are `iso-8859-1`, `utf-8`, `windows-1252`, `shift_JIS`, `big5`, etc.

Returns TRUE for success, FALSE for failure.

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

### UnixCompress.UnTarZ

`Chilkat 11.7.0 · wc · UnixCompress · UnTarZ · method`

```c
BOOL CkUnixCompressW_UnTarZ(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *destDir, BOOL bNoAbsolute);
```

Unpacks a .tar.Z file. The decompress and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring.

Returns TRUE for success, FALSE for failure.

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

## Events and callbacks

This binding delivers progress information through callbacks (AbortCheck, PercentDone, ProgressInfo, TaskCompleted) rather than events. See `guide.md` for how to attach them in Unicode C.

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

```c
HCkTaskW CkUnixCompressW_CompressFileAsync(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);
HCkTaskW CkUnixCompressW_UncompressFileAsync(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);
HCkTaskW CkUnixCompressW_UncompressFileToStringAsync(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *charset);
HCkTaskW CkUnixCompressW_UnTarZAsync(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *destDir, BOOL 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 | — |
| `UncompressFileToMem` | method | before 11.6.1 | — |
| `UncompressMemory` | method | before 11.6.1 | — |
| `UncompressMemToFile` | method | before 11.6.1 | — |
| `UncompressString` | method | before 11.6.1 | — |

## Related classes

[`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/wc/classes/Task.md)

