---
product: Chilkat
product_version: 11.7.0
language: asp
language_label: Classic ASP
class: UnixCompress
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/asp_UnixCompressRef.html
---
# Chilkat UnixCompress — Classic ASP — v11.7.0

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

```visual-basic
set unixCompress = Server.CreateObject("Chilkat.UnixCompress")

' ... use unixCompress ...

set unixCompress = Nothing
```

Classic ASP creates Chilkat objects with `Server.CreateObject`. The registered Chilkat ActiveX must match the bitness of the IIS application pool: a pool with *Enable 32-Bit Applications* set to True needs the 32-bit ActiveX, otherwise the 64-bit ActiveX. To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `Server.CreateObject("Chilkat.UnixCompress.11")` for Chilkat v11.\*.\*.

VBScript requires `set` when assigning an object, so the signatures on this page show `set x = obj.Method(...)` for methods that return a Chilkat object; test the result with `Is Nothing`, since a method that fails to return an object returns `Nothing`. A method with no return value is called as a statement without parentheses (`obj.Method arg1, arg2`). Boolean properties, arguments and return values are integers in the ActiveX: pass `1` or `0`, and test success with `= 1`. Byte arrays are Variant arrays and can be sent with `Response.BinaryWrite`. Asynchronous (*\*Async*) methods and event callbacks are not used from Classic ASP.

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 Classic ASP.

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` | `unixCompress.DebugLogFilePath ' 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` | `unixCompress.LastBinaryResult ' 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` | `unixCompress.LastErrorHtml ' String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `unixCompress.LastErrorText ' String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `unixCompress.LastErrorXml ' String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `unixCompress.LastMethodSuccess ' Long` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `unixCompress.LastStringResult ' 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` | `unixCompress.LastStringResultLen ' Long (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `unixCompress.VerboseLogging ' Long` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `unixCompress.Version ' String (read-only)` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `unixCompress.AbortCurrent ' Long` |
| `CompressFile` | method | `success = unixCompress.CompressFile(inFilename, destPath) ' Long (1/0)` |
| `CompressFileToMem` | method | `bytes = unixCompress.CompressFileToMem(inFilename) ' Variant` |
| `CompressMemory` | method | `bytes = unixCompress.CompressMemory(inData) ' Variant` |
| `CompressMemToFile` | method | `success = unixCompress.CompressMemToFile(inData, destPath) ' Long (1/0)` |
| `CompressString` | method | `bytes = unixCompress.CompressString(inStr, charset) ' Variant` |
| `CompressStringToFile` | method | `success = unixCompress.CompressStringToFile(inStr, charset, destPath) ' Long (1/0)` |
| `ReadFile` | method | `bytes = unixCompress.ReadFile(filename) ' Variant` |
| `UncompressFile` | method | `success = unixCompress.UncompressFile(inFilename, destPath) ' Long (1/0)` |
| `UncompressFileToMem` | method | `bytes = unixCompress.UncompressFileToMem(inFilename) ' Variant` |
| `UncompressFileToString` | method | `str = unixCompress.UncompressFileToString(zFilename, charset) ' String` |
| `UncompressMemory` | method | `bytes = unixCompress.UncompressMemory(inData) ' Variant` |
| `UncompressMemToFile` | method | `success = unixCompress.UncompressMemToFile(inData, destPath) ' Long (1/0)` |
| `UncompressString` | method | `str = unixCompress.UncompressString(inCompressedData, charset) ' String` |
| `UnTarZ` | method | `success = unixCompress.UnTarZ(zFilename, destDir, bNoAbsolute) ' Long (1/0)` |
| `WriteFile` | method | `success = unixCompress.WriteFile(filename, binaryData) ' Long (1/0)` |

## Properties

### UnixCompress.AbortCurrent

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

```visual-basic
unixCompress.AbortCurrent  ' Long
```

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

## Methods

### UnixCompress.CompressFile

`Chilkat 11.7.0 · asp · UnixCompress · CompressFile · method`

```visual-basic
success = unixCompress.CompressFile(inFilename, destPath)  ' Long (1/0)
```

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.

### UnixCompress.CompressFileToMem

`Chilkat 11.7.0 · asp · UnixCompress · CompressFileToMem · method`

```visual-basic
bytes = unixCompress.CompressFileToMem(inFilename)  ' 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.  
An empty array will have a UBound of -1 meaning 0 elements.

### UnixCompress.CompressMemory

`Chilkat 11.7.0 · asp · UnixCompress · CompressMemory · method`

```visual-basic
bytes = unixCompress.CompressMemory(inData)  ' 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.  
An empty array will have a UBound of -1 meaning 0 elements.

### UnixCompress.CompressMemToFile

`Chilkat 11.7.0 · asp · UnixCompress · CompressMemToFile · method`

```visual-basic
success = unixCompress.CompressMemToFile(inData, destPath)  ' Long (1/0)
```

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 · asp · UnixCompress · CompressString · method`

```visual-basic
bytes = unixCompress.CompressString(inStr, charset)  ' 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.  
An empty array will have a UBound of -1 meaning 0 elements.

### UnixCompress.CompressStringToFile

`Chilkat 11.7.0 · asp · UnixCompress · CompressStringToFile · method`

```visual-basic
success = unixCompress.CompressStringToFile(inStr, charset, destPath)  ' Long (1/0)
```

**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.ReadFile

`Chilkat 11.7.0 · asp · UnixCompress · ReadFile · method`

```visual-basic
bytes = unixCompress.ReadFile(filename)  ' 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.  
An empty array will have a UBound of -1 meaning 0 elements.

### UnixCompress.UncompressFile

`Chilkat 11.7.0 · asp · UnixCompress · UncompressFile · method`

```visual-basic
success = unixCompress.UncompressFile(inFilename, destPath)  ' Long (1/0)
```

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

Returns 1 for success, 0 for failure.

### UnixCompress.UncompressFileToMem

`Chilkat 11.7.0 · asp · UnixCompress · UncompressFileToMem · method`

```visual-basic
bytes = unixCompress.UncompressFileToMem(inFilename)  ' 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.  
An empty array will have a UBound of -1 meaning 0 elements.

### UnixCompress.UncompressFileToString

`Chilkat 11.7.0 · asp · UnixCompress · UncompressFileToString · method`

```visual-basic
str = unixCompress.UncompressFileToString(zFilename, charset)  ' 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 `Nothing` on failure

### UnixCompress.UncompressMemory

`Chilkat 11.7.0 · asp · UnixCompress · UncompressMemory · method`

```visual-basic
bytes = unixCompress.UncompressMemory(inData)  ' 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.  
An empty array will have a UBound of -1 meaning 0 elements.

### UnixCompress.UncompressMemToFile

`Chilkat 11.7.0 · asp · UnixCompress · UncompressMemToFile · method`

```visual-basic
success = unixCompress.UncompressMemToFile(inData, destPath)  ' Long (1/0)
```

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 · asp · UnixCompress · UncompressString · method`

```visual-basic
str = unixCompress.UncompressString(inCompressedData, charset)  ' 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 `Nothing` on failure

### UnixCompress.UnTarZ

`Chilkat 11.7.0 · asp · UnixCompress · UnTarZ · method`

```visual-basic
success = unixCompress.UnTarZ(zFilename, destDir, bNoAbsolute)  ' Long (1/0)
```

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.

### UnixCompress.WriteFile

`Chilkat 11.7.0 · asp · UnixCompress · WriteFile · method`

```visual-basic
success = unixCompress.WriteFile(filename, binaryData)  ' Long (1/0)
```

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

Returns 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks.

