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

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

**Object Creation**

```foxpro
loUnixCompress = CreateObject('Chilkat.UnixCompress')
```

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

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in FoxPro.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `DebugLogFilePath As String` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `LastBinaryResult As Variant (read-only)` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `LastErrorHtml As String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText As String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml As String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess As Number` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `LastStringResult As String (read-only)` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `LastStringResultLen As Number (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `VerboseLogging As Number` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version As String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `AbortCurrent As Number` |
| `HeartbeatMs` | property, read/write | `HeartbeatMs As Number` |
| `CompressFile` | method | `CompressFile(inFilename As String, destPath As String) As Number` |
| `CompressFileToMem` | method | `CompressFileToMem(inFilename As String) As Variant` |
| `CompressMemory` | method | `CompressMemory(inData As Variant) As Variant` |
| `CompressMemToFile` | method | `CompressMemToFile(inData As Variant, destPath As String) As Number` |
| `CompressString` | method | `CompressString(inStr As String, charset As String) As Variant` |
| `CompressStringToFile` | method | `CompressStringToFile(inStr As String, charset As String, destPath As String) As Number` |
| `LoadTaskCaller` | method | `LoadTaskCaller(task As ChilkatTask) As Number` |
| `ReadFile` | method | `ReadFile(filename As String) As Variant` |
| `UncompressFile` | method | `UncompressFile(inFilename As String, destPath As String) As Number` |
| `UncompressFileToMem` | method | `UncompressFileToMem(inFilename As String) As Variant` |
| `UncompressFileToString` | method | `UncompressFileToString(zFilename As String, charset As String) As String` |
| `UncompressMemory` | method | `UncompressMemory(inData As Variant) As Variant` |
| `UncompressMemToFile` | method | `UncompressMemToFile(inData As Variant, destPath As String) As Number` |
| `UncompressString` | method | `UncompressString(inCompressedData As Variant, charset As String) As String` |
| `UnTarZ` | method | `UnTarZ(zFilename As String, destDir As String, bNoAbsolute As Number) As Number` |
| `WriteFile` | method | `WriteFile(filename As String, binaryData As Variant) As Number` |

## Properties

### UnixCompress.AbortCurrent

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

```foxpro
AbortCurrent As Number
```

When set to `1`, 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 `0` when the next method is called. When the abort occurs, this property is reset to `0`. 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 · foxpro · UnixCompress · HeartbeatMs · property · read/write`

```foxpro
HeartbeatMs As Number
```

**Full documentation for this property (same in every language):** [Event Callback Examples](https://www.chilkatsoft.com/ai-docs/v/11.7.0/articles/event_callback_examples.md)

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

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

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

Returns 1 for success, 0 for failure.

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

### UnixCompress.CompressFileToMem

`Chilkat 11.7.0 · foxpro · UnixCompress · CompressFileToMem · method`

```foxpro
CompressFileToMem(inFilename As String) As Variant
```

Unix compresses a file to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

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

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

### UnixCompress.CompressMemory

`Chilkat 11.7.0 · foxpro · UnixCompress · CompressMemory · method`

```foxpro
CompressMemory(inData As Variant) As Variant
```

Compresses in-memory data to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

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

### UnixCompress.CompressMemToFile

`Chilkat 11.7.0 · foxpro · UnixCompress · CompressMemToFile · method`

```foxpro
CompressMemToFile(inData As Variant, destPath As String) As Number
```

Unix compresses and creates a .Z file from in-memory data. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns 1 for success, 0 for failure.

### UnixCompress.CompressString

`Chilkat 11.7.0 · foxpro · UnixCompress · CompressString · method`

```foxpro
CompressString(inStr As String, charset As String) As Variant
```

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

Compresses a string to an in-memory image of a .Z file. Prior to compression, the string is converted to the character encoding specified by `charset`. 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 a zero-length byte array (as a Variant) on failure.

### UnixCompress.CompressStringToFile

`Chilkat 11.7.0 · foxpro · UnixCompress · CompressStringToFile · method`

```foxpro
CompressStringToFile(inStr As String, charset As String, destPath As String) As Number
```

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

### UnixCompress.LoadTaskCaller

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

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

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

### UnixCompress.ReadFile

`Chilkat 11.7.0 · foxpro · UnixCompress · ReadFile · method`

```foxpro
ReadFile(filename As String) As Variant
```

Convenience method to read an entire file and return as a byte array.

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

### UnixCompress.UncompressFile

`Chilkat 11.7.0 · foxpro · UnixCompress · UncompressFile · method`

```foxpro
UncompressFile(inFilename As String, destPath As String) As Number
```

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

Returns 1 for success, 0 for failure.

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

### UnixCompress.UncompressFileToMem

`Chilkat 11.7.0 · foxpro · UnixCompress · UncompressFileToMem · method`

```foxpro
UncompressFileToMem(inFilename As String) As Variant
```

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

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

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

### UnixCompress.UncompressFileToString

`Chilkat 11.7.0 · foxpro · UnixCompress · UncompressFileToString · method`

```foxpro
UncompressFileToString(zFilename 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)

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

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

### UnixCompress.UncompressMemory

`Chilkat 11.7.0 · foxpro · UnixCompress · UncompressMemory · method`

```foxpro
UncompressMemory(inData As Variant) As Variant
```

Uncompresses from an in-memory image of a .Z file directly into memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

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

### UnixCompress.UncompressMemToFile

`Chilkat 11.7.0 · foxpro · UnixCompress · UncompressMemToFile · method`

```foxpro
UncompressMemToFile(inData As Variant, destPath As String) As Number
```

Uncompresses from an in-memory image of a .Z file to a file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns 1 for success, 0 for failure.

### UnixCompress.UncompressString

`Chilkat 11.7.0 · foxpro · UnixCompress · UncompressString · method`

```foxpro
UncompressString(inCompressedData As Variant, 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)

Uncompresses from an in-memory image of a .Z file directly to a string. The `charset` specifies the character encoding used to interpret the bytes resulting from the decompression. 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 `.NULL.` on failure

### UnixCompress.UnTarZ

`Chilkat 11.7.0 · foxpro · UnixCompress · UnTarZ · method`

```foxpro
UnTarZ(zFilename As String, destDir As String, bNoAbsolute As Number) As Number
```

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

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

### UnixCompress.WriteFile

`Chilkat 11.7.0 · foxpro · UnixCompress · WriteFile · method`

```foxpro
WriteFile(filename As String, binaryData As Variant) As Number
```

Convenience method for writing the contents of a byte array to a file.

Returns 1 for success, 0 for failure.

## Events and callbacks

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

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

```foxpro
unixCompressEventHandler = CREATEOBJECT("MyUnixCompressEvents")
loUnixCompress = CreateObject('Chilkat.UnixCompress')
EVENTHANDLER(loUnixCompress, unixCompressEventHandler)

DEFINE CLASS MyUnixCompressEvents AS SESSION OLEPUBLIC
IMPLEMENTS _IChilkatEvents IN "Chilkat.UnixCompress"

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

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

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

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

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

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


ENDDEFINE
```

### UnixCompress.AbortCheck (event)

`Chilkat 11.7.0 · foxpro · UnixCompress · AbortCheck · event`

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

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

**FoxPro event implementation:**

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

### UnixCompress.PercentDone (event)

`Chilkat 11.7.0 · foxpro · UnixCompress · PercentDone · event`

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

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

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

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

**FoxPro event implementation:**

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

### UnixCompress.ProgressInfo (event)

`Chilkat 11.7.0 · foxpro · UnixCompress · ProgressInfo · event`

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

This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

**FoxPro event implementation:**

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

### UnixCompress.TaskCompleted (event)

`Chilkat 11.7.0 · foxpro · UnixCompress · TaskCompleted · event`

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

Called from the background thread when an asynchronous task completes.

**FoxPro event implementation:**

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

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```foxpro
CompressFileAsync(inFilename As String, destPath As String) As ChilkatTask
CompressFileToMemAsync(inFilename As String) As ChilkatTask
UncompressFileAsync(inFilename As String, destPath As String) As ChilkatTask
UncompressFileToMemAsync(inFilename As String) As ChilkatTask
UncompressFileToStringAsync(zFilename As String, charset As String) As ChilkatTask
UnTarZAsync(zFilename As String, destDir As String, bNoAbsolute As Number) As ChilkatTask
```

## Related classes

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

