Bz2

Set this property to true 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 false. If no operation is running, a previously set value is cleared when the next method begins.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Specifies the interval, in milliseconds, between AbortCheck event callbacks during supported long-running compression and decompression operations. The default is 0, which disables AbortCheck callbacks.

Set a positive value, such as 200, when the application needs periodic opportunities to request cancellation. The interval is approximate; callbacks occur only while an operation is at a point where progress events can be delivered.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

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.

Version of the component/library, such as "10.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.

Returns true for success, false for failure.

Creates an asynchronous task to call the CompressBd method with the arguments provided.

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

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.

Returns true for success, false for failure.

Creates an asynchronous task to call the CompressFile method with the arguments provided.

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

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

Returns an empty byte array on failure

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided.

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

Compresses the bytes in inData and returns the complete standard BZip2 stream as an in-memory byte array.

Returns an empty byte array on failure

Creates an asynchronous task to call the CompressMemory method with the arguments provided.

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

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

Returns true for success, false for failure.

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided.

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

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

Returns true for success, false for failure.

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

Returns true for success, false for failure.

Creates an asynchronous task to call the UncompressBd method with the arguments provided.

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

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.

Returns true for success, false for failure.

Creates an asynchronous task to call the UncompressFile method with the arguments provided.

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

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

Returns an empty byte array on failure

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.

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

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

Returns an empty byte array on failure

Creates an asynchronous task to call the UncompressMemory method with the arguments provided.

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

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

Returns true for success, false for failure.

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided.

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

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

Chilkat .NET Framework 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 .NET Core Event Implementation

Event callback implementation:

public void handleAbortCheck(out bool abort)
	{
	    // 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);

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.

Chilkat .NET Framework 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 .NET Core Event Implementation

Event callback implementation:

public void handlePercentDone(int pctDone, out bool abort)
	{
	    // 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);

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

Chilkat .NET Framework 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 .NET Core Event Implementation

Event callback implementation:

public void handleProgressInfo(string name, string value)
	{
	    // 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);

Called from the background thread when an asynchronous task completes.

Chilkat .NET Framework 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 .NET Core Event Implementation

Event callback implementation:

public void handleTaskIdCompleted(int taskId)
	{
	    // 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);