---
product: Chilkat
product_version: 11.7.0
language: powerbuilder
language_label: PowerBuilder
class: Bz2
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/powerbuilder_Bz2Ref.html
---
# Chilkat Bz2 — PowerBuilder — v11.7.0

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

```powerbuilder
oleobject loo_Bz2
integer li_rc

loo_Bz2 = create oleobject
li_rc = loo_Bz2.ConnectToNewObject("Chilkat.Bz2")
if li_rc < 0 then
    destroy loo_Bz2
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// ... use loo_Bz2 ...

destroy loo_Bz2
```

PowerBuilder uses the Chilkat ActiveX through an `oleobject`: declare the variable, `create` it, connect it to the Chilkat class with `ConnectToNewObject`, and `destroy` it when finished. A negative return code from `ConnectToNewObject` means the ActiveX is not registered, or the registered ActiveX does not match the bitness (32-bit or 64-bit) of the PowerBuilder target.

Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also `oleobject` variables and must likewise be destroyed. A method that fails to return an object returns `null`; test with `IsNull()`. In the signatures on this page, the Chilkat class name identifies which object is expected or returned; the PowerBuilder variable type is always `oleobject`.

To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `ConnectToNewObject("Chilkat.Bz2.11")` for Chilkat v11.\*.\*.

Members typed `blob` exchange binary data as a Variant byte array. The PowerBuilder examples instead use the `BinData`-based alternatives (methods ending in *Bd*), which keep binary data inside Chilkat objects.

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

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

## Member index

| Member | Kind | Signature |
|---|---|---|
| `AbortCurrent` | property, read/write | `long AbortCurrent` |
| `CompressBd` | method | `long CompressBd(ChilkatBinData bd)` |
| `CompressFile` | method | `long CompressFile(string inFilename, string toPath)` |
| `CompressFileToMem` | method | `blob CompressFileToMem(string inFilename)` |
| `CompressMemory` | method | `blob CompressMemory(blob inData)` |
| `CompressMemToFile` | method | `long CompressMemToFile(blob inData, string toPath)` |
| `LoadTaskCaller` | method | `long LoadTaskCaller(ChilkatTask task)` |
| `UncompressBd` | method | `long UncompressBd(ChilkatBinData bd)` |
| `UncompressFile` | method | `long UncompressFile(string inFilename, string toPath)` |
| `UncompressFileToMem` | method | `blob UncompressFileToMem(string inFilename)` |
| `UncompressMemory` | method | `blob UncompressMemory(blob inData)` |
| `UncompressMemToFile` | method | `long UncompressMemToFile(blob inData, string toPath)` |

## Properties

### Bz2.AbortCurrent

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

```powerbuilder
long AbortCurrent
```

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 · powerbuilder · Bz2 · CompressBd · method · since 11.0.0`

```powerbuilder
long CompressBd(ChilkatBinData bd)
```

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.

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

### Bz2.CompressFile

`Chilkat 11.7.0 · powerbuilder · Bz2 · CompressFile · method`

```powerbuilder
long CompressFile(string inFilename, string toPath)
```

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.

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

### Bz2.CompressFileToMem

`Chilkat 11.7.0 · powerbuilder · Bz2 · CompressFileToMem · method`

```powerbuilder
blob CompressFileToMem(string inFilename)
```

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.

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

### Bz2.CompressMemory

`Chilkat 11.7.0 · powerbuilder · Bz2 · CompressMemory · method`

```powerbuilder
blob CompressMemory(blob inData)
```

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.

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

### Bz2.CompressMemToFile

`Chilkat 11.7.0 · powerbuilder · Bz2 · CompressMemToFile · method`

```powerbuilder
long CompressMemToFile(blob inData, string toPath)
```

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

Returns 1 for success, 0 for failure.

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

### Bz2.LoadTaskCaller

`Chilkat 11.7.0 · powerbuilder · Bz2 · LoadTaskCaller · method · since 9.5.0.80`

```powerbuilder
long LoadTaskCaller(ChilkatTask task)
```

Loads this `Bz2` object with the caller state associated with the asynchronous operation represented by `task`.

**Advanced async infrastructure:** This method is used to recover the original caller object associated with a completed task. It is not normally needed by application code. Pass a `Task` created by a compatible `Bz2` asynchronous method; an unrelated task cannot be loaded.

Returns 1 for success, 0 for failure.

### Bz2.UncompressBd

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

```powerbuilder
long UncompressBd(ChilkatBinData bd)
```

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.

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

### Bz2.UncompressFile

`Chilkat 11.7.0 · powerbuilder · Bz2 · UncompressFile · method`

```powerbuilder
long UncompressFile(string inFilename, string toPath)
```

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.

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

### Bz2.UncompressFileToMem

`Chilkat 11.7.0 · powerbuilder · Bz2 · UncompressFileToMem · method`

```powerbuilder
blob UncompressFileToMem(string inFilename)
```

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.

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

### Bz2.UncompressMemory

`Chilkat 11.7.0 · powerbuilder · Bz2 · UncompressMemory · method`

```powerbuilder
blob UncompressMemory(blob inData)
```

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.

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

### Bz2.UncompressMemToFile

`Chilkat 11.7.0 · powerbuilder · Bz2 · UncompressMemToFile · method`

```powerbuilder
long UncompressMemToFile(blob inData, string toPath)
```

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.

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

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

```powerbuilder
ChilkatTask CompressBdAsync(ChilkatBinData bd)
ChilkatTask CompressFileAsync(string inFilename, string toPath)
ChilkatTask CompressFileToMemAsync(string inFilename)
ChilkatTask CompressMemoryAsync(blob inData)
ChilkatTask CompressMemToFileAsync(blob inData, string toPath)
ChilkatTask UncompressBdAsync(ChilkatBinData bd)
ChilkatTask UncompressFileAsync(string inFilename, string toPath)
ChilkatTask UncompressFileToMemAsync(string inFilename)
ChilkatTask UncompressMemoryAsync(blob inData)
ChilkatTask UncompressMemToFileAsync(blob inData, string toPath)
```

## Related classes

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

