Chilkat C# Bz2 Class Reference

Bz2

Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.

Object Creation

(C#)
Chilkat.Bz2 obj = new Chilkat.Bz2();
(VB.NET)
Dim obj As New Chilkat.Bz2()

Properties

public bool EnableEvents {get; set; }

To be documented soon...

public string LastErrorHtml {get; }

Error information in HTML format for the last method called.

public string LastErrorText {get; }

Error information in plain-text format for the last method called.

public string LastErrorXml {get; }

Error information in XML format for the last method called.

Methods

public bool CompressFile(string inFilename, string outBz2Filename);

Compresses a file to create a BZip2 compressed file (.bz2).

Returns true for success, false for failure.

public byte[] CompressFileToMem(string inFilename);

BZip2 compresses a file to an in-memory image of a .bz2 file.

Returns a NULL object reference on failure.

Returns an empty byte array on failure

public bool CompressMemToFile(byte[] inData, string outFilename);

BZip2 compresses and creates a .bz2 file from in-memory data.

Returns true for success, false for failure.

public byte[] CompressMemory(byte[] inData);

Compresses in-memory data to an in-memory image of a .bz2 file.

Returns an empty byte array on failure

public bool SaveLastError(string filename);

Saves the last error information to an XML formatted file.

public bool UncompressFile(string inFilename, string outFilename);

Unzips a .bz2 file.

Returns true for success, false for failure.

public byte[] UncompressFileToMem(string inFilename);

Unzips a .bz2 file directly to memory.

Returns a NULL object reference on failure.

Returns an empty byte array on failure

public bool UncompressMemToFile(byte[] inData, string outFilename);

Unzips from an in-memory image of a .bz2 file to a file.

Returns true for success, false for failure.

public byte[] UncompressMemory(byte[] inData);

Unzips from an in-memory image of a .bz2 file directly into memory.

Returns a NULL object reference on failure.

Returns an empty byte array on failure

public bool UnlockComponent(string regCode);

Unlocks the component allowing for the full functionality to be used. If a permanent (purchased) unlock code is passed, there is no expiration. Any other string automatically begins a fully-functional 30-day trial the first time UnlockComponent is called.

Returns true for success, false for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

How UnlockComponent Works