Bz2 C# Reference Documentation

Bz2

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

Object Creation

Chilkat.Bz2 obj = new Chilkat.Bz2();

Properties

public bool AbortCurrent {get; set; }

Introduced in version 9.5.0.58

When set to true, 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 false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

public string DebugLogFilePath {get; set; }

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

public int HeartbeatMs {get; set; }

To be documented soon...

public string LastErrorHtml {get; }

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

public string LastErrorText {get; }

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

public string LastErrorXml {get; }

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

public bool LastMethodSuccess {get; set; }

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

public bool VerboseLogging {get; set; }

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

public string Version {get; }

Version of the component/library, such as "9.5.0.63"

Methods

public bool CompressFile(string inFilename, string toPath);

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

Returns true for success, false for failure.

public Task CompressFileAsync(string inFilename, string toPath);

Creates an asynchronous task to call the CompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

public byte[] CompressFileToMem(string inFilename);

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

Returns an empty byte array on failure

public Task CompressFileToMemAsync(string inFilename);

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

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 Task CompressMemoryAsync(byte[] inData);

Creates an asynchronous task to call the CompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

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

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

Returns true for success, false for failure.

public Task CompressMemToFileAsync(byte[] inData, string toPath);

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

public bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

public bool UncompressFile(string inFilename, string toPath);

Unzips a .bz2 file.

Returns true for success, false for failure.

public Task UncompressFileAsync(string inFilename, string toPath);

Creates an asynchronous task to call the UncompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

public byte[] UncompressFileToMem(string inFilename);

Unzips a .bz2 file directly to memory.

Returns an empty byte array on failure

public Task UncompressFileToMemAsync(string inFilename);

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

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

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

Returns an empty byte array on failure

public Task UncompressMemoryAsync(byte[] inData);

Creates an asynchronous task to call the UncompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

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

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

Returns true for success, false for failure.

public Task UncompressMemToFileAsync(byte[] inData, string toPath);

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

public bool UnlockComponent(string regCode);

Unlocks the component allowing for the full functionality to be used. If a 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

Events

public event AbortCheckEventHandler OnAbortCheck;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

Chilkat .NET Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void bz_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
bz.OnAbortCheck += bz_OnAbortCheck;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleAbortCheckEventHandler OnhandleAbortCheck
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
// ...
Chilkat.Bz2.AbortCheck abortCheck = new Chilkat.Bz2.AbortCheck(handleAbortCheck);
bz.setAbortCheckCb(abortCheck);

public event BinaryDataEventHandler OnBinaryData;

Binary data provided by certain methods.

Chilkat .NET Event Implementation

Args are passed using Chilkat.BinaryDataEventArgs

Event callback implementation:

private void bz_OnBinaryData(object sender, Chilkat.BinaryDataEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
bz.OnBinaryData += bz_OnBinaryData;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleBinaryDataEventHandler OnhandleBinaryData
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
// ...
Chilkat.Bz2.BinaryData binaryData = new Chilkat.Bz2.BinaryData(handleBinaryData);
bz.setBinaryDataCb(binaryData);

public event PercentDoneEventHandler OnPercentDone;

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

Chilkat .NET Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void bz_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
bz.OnPercentDone += bz_OnPercentDone;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handlePercentDoneEventHandler OnhandlePercentDone
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
// ...
Chilkat.Bz2.PercentDone percentDone = new Chilkat.Bz2.PercentDone(handlePercentDone);
bz.setPercentDoneCb(percentDone);

public event ProgressInfoEventHandler OnProgressInfo;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

Chilkat .NET Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void bz_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
bz.OnProgressInfo += bz_OnProgressInfo;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleProgressInfoEventHandler OnhandleProgressInfo
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
// ...
Chilkat.Bz2.ProgressInfo progressInfo = new Chilkat.Bz2.ProgressInfo(handleProgressInfo);
bz.setProgressInfoCb(progressInfo);

public event TaskCompletedEventHandler OnTaskCompleted;

Called in the background thread when an asynchronous task completes.

C# TaskCompleted Event Callback Example

Chilkat .NET Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void bz_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
bz.OnTaskCompleted += bz_OnTaskCompleted;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleTaskIdCompletedEventHandler OnhandleTaskIdCompleted
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
// ...
Chilkat.Bz2.TaskIdCompleted taskIdCompleted = new Chilkat.Bz2.TaskIdCompleted(handleTaskIdCompleted);
bz.setTaskIdCompletedCb(taskIdCompleted);

public event TextDataEventHandler OnTextData;

Text data provided by certain methods.

Chilkat .NET Event Implementation

Args are passed using Chilkat.TextDataEventArgs

Event callback implementation:

private void bz_OnTextData(object sender, Chilkat.TextDataEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
bz.OnTextData += bz_OnTextData;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleTextDataEventHandler OnhandleTextData
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Bz2 bz = new Chilkat.Bz2();
// ...
Chilkat.Bz2.TextData textData = new Chilkat.Bz2.TextData(handleTextData);
bz.setTextDataCb(textData);