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

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

## Purpose

`Chilkat.Bz2` provides BZip2 compression and decompression for files, memory buffers, and BinData. It can create standard .bz2 file images, decompress .bz2 content back to its original bytes, and support abortable long-running operations.

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

## Object creation, unlocking and error handling

**Object Creation**

```visual-basic
set bz2 = Server.CreateObject("Chilkat.Bz2")

' ... use bz2 ...

set bz2 = 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.Bz2.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` | `bz2.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` | `bz2.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` | `bz2.LastErrorHtml ' String (read-only)` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `bz2.LastErrorText ' String (read-only)` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `bz2.LastErrorXml ' String (read-only)` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `bz2.LastMethodSuccess ' Long` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `bz2.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` | `bz2.LastStringResultLen ' Long (read-only)` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `bz2.VerboseLogging ' Long` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `bz2.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 | `bz2.AbortCurrent ' Long` |
| `CompressBd` | method | `success = bz2.CompressBd(bd) ' Long (1/0)` |
| `CompressFile` | method | `success = bz2.CompressFile(inFilename, toPath) ' Long (1/0)` |
| `CompressFileToMem` | method | `bytes = bz2.CompressFileToMem(inFilename) ' Variant` |
| `CompressMemory` | method | `bytes = bz2.CompressMemory(inData) ' Variant` |
| `CompressMemToFile` | method | `success = bz2.CompressMemToFile(inData, toPath) ' Long (1/0)` |
| `UncompressBd` | method | `success = bz2.UncompressBd(bd) ' Long (1/0)` |
| `UncompressFile` | method | `success = bz2.UncompressFile(inFilename, toPath) ' Long (1/0)` |
| `UncompressFileToMem` | method | `bytes = bz2.UncompressFileToMem(inFilename) ' Variant` |
| `UncompressMemory` | method | `bytes = bz2.UncompressMemory(inData) ' Variant` |
| `UncompressMemToFile` | method | `success = bz2.UncompressMemToFile(inData, toPath) ' Long (1/0)` |

## Properties

### Bz2.AbortCurrent

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

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

Set this property to `1` to request cancellation of the compression or decompression operation currently executing on this object. Long-running operations check the request periodically; an operation that finishes quickly may complete before the request is observed.

A synchronous call can be cancelled by setting this property from another thread. After cancellation is processed, Chilkat resets the property to `0`. If no operation is running, a previously set value is cleared when the next method begins.

**Cancellation is cooperative:** Setting this property requests an abort; it does not guarantee immediate termination. Check the method's return value and `LastErrorText` to determine the final outcome.

## Methods

### Bz2.CompressBd

`Chilkat 11.7.0 · asp · Bz2 · CompressBd · method · since 11.0.0`

```visual-basic
success = bz2.CompressBd(bd)  ' Long (1/0)
```

Compresses the current contents of `bd` in place. On success, the `BinData` no longer contains the original bytes; it contains the complete standard BZip2 stream that may be saved with a `.bz2` extension.

**In-place transformation:** Preserve a copy of the original data if it is still needed after this call. A BZip2 stream contains a stream header, one or more compressed blocks with integrity checks, and an end-of-stream marker. It does not contain archive filenames or directory entries.

Returns 1 for success, 0 for failure.

### Bz2.CompressFile

`Chilkat 11.7.0 · asp · Bz2 · CompressFile · method`

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

Reads the file at `inFilename` and writes its compressed bytes as a standard BZip2 stream to the file at `toPath`. The output is conventionally given a `.bz2` extension.

Both arguments must identify files, not directories. They may be absolute or relative paths, for example `data/report.txt` and `data/report.txt.bz2`.

**BZip2 is a compressor, not an archive format:** A `.bz2` file represents one compressed byte stream. It does not store the original filename, directory path, timestamps, permissions, or multiple archive entries. Formats such as `.tar.bz2` first combine files in a TAR archive and then compress that TAR stream with BZip2.

Returns 1 for success, 0 for failure.

### Bz2.CompressFileToMem

`Chilkat 11.7.0 · asp · Bz2 · CompressFileToMem · method`

```visual-basic
bytes = bz2.CompressFileToMem(inFilename)  ' Variant
```

Reads the file at `inFilename`, compresses it with BZip2, and returns the complete `.bz2` byte stream in memory.

Returns a zero-length byte array (as a Variant) on failure.  
An empty array will have a UBound of -1 meaning 0 elements.

### Bz2.CompressMemory

`Chilkat 11.7.0 · asp · Bz2 · CompressMemory · method`

```visual-basic
bytes = bz2.CompressMemory(inData)  ' Variant
```

Compresses the bytes in `inData` and returns the complete standard BZip2 stream as an in-memory 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.

### Bz2.CompressMemToFile

`Chilkat 11.7.0 · asp · Bz2 · CompressMemToFile · method`

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

Compresses the bytes in `inData` and writes the resulting standard BZip2 stream to the file at `toPath`.

Returns 1 for success, 0 for failure.

### Bz2.UncompressBd

`Chilkat 11.7.0 · asp · Bz2 · UncompressBd · method · since 11.0.0`

```visual-basic
success = bz2.UncompressBd(bd)  ' Long (1/0)
```

Decompresses the BZip2 stream currently contained in `bd` in place. On success, the `BinData` is replaced with the original uncompressed bytes.

**Input requirement:** `bd` must contain a complete, valid BZip2 stream, such as the bytes of a `.bz2` file or the output of `CompressBd`. This method operates on binary data and does not perform character-set conversion.

Returns 1 for success, 0 for failure.

### Bz2.UncompressFile

`Chilkat 11.7.0 · asp · Bz2 · UncompressFile · method`

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

Reads the BZip2 stream from the file at `inFilename`, decompresses it, and writes the original uncompressed bytes to the file at `toPath`.

Both arguments must identify files, not directories. Chilkat does not derive the destination name from the `.bz2` filename because the BZip2 stream does not contain the original filename.

**Terminology:** This method decompresses BZip2 data; it does not “unzip” a ZIP archive. A `.bz2` file normally contains a single compressed byte stream rather than a collection of named files.

Returns 1 for success, 0 for failure.

### Bz2.UncompressFileToMem

`Chilkat 11.7.0 · asp · Bz2 · UncompressFileToMem · method`

```visual-basic
bytes = bz2.UncompressFileToMem(inFilename)  ' Variant
```

Reads and decompresses the BZip2 stream in the file at `inFilename`, returning the original uncompressed bytes in memory.

Returns a zero-length byte array (as a Variant) on failure.  
An empty array will have a UBound of -1 meaning 0 elements.

### Bz2.UncompressMemory

`Chilkat 11.7.0 · asp · Bz2 · UncompressMemory · method`

```visual-basic
bytes = bz2.UncompressMemory(inData)  ' Variant
```

Interprets `inData` as a complete BZip2 stream and returns the decompressed bytes in memory.

Returns a zero-length byte array (as a Variant) on failure.  
An empty array will have a UBound of -1 meaning 0 elements.

### Bz2.UncompressMemToFile

`Chilkat 11.7.0 · asp · Bz2 · UncompressMemToFile · method`

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

Interprets `inData` as a complete BZip2 stream, decompresses it, and writes the original bytes to the file at `toPath`.

Returns 1 for success, 0 for failure.

## Events and callbacks

This binding has no event callbacks.

## Related classes

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

