Bz2 C++ Reference Documentation

CkBz2

Current Version: 11.1.0

Requires Chilkat Bundle License

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

Object Creation

// Local variable on the stack
CkBz2 obj;

// Dynamically allocate/delete
CkBz2 *pObj = new CkBz2();
// ...
delete pObj;

Properties

AbortCurrent

bool get_AbortCurrent(void);
void put_AbortCurrent(bool newVal);

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

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

HeartbeatMs

int get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.

More Information and Examples

Event Callback Examples

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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.

LastErrorText

void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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.

LastMethodSuccess

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

Utf8

bool get_Utf8(void);
void put_Utf8(bool newVal);

When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.

In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

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

void get_Version(CkString &str);
const char *version(void);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressBd

bool CompressBd(CkBinData &bd);

Introduced in version 11.0.0

BZ2 compress the contents of bd. After compression, the bd contains the binary content of a .bz2 file, which is slightly different than simple BZIP2 compressed data because a .bz2 file contains:

Header
Compressed blocks
End-of-stream trailer

Returns true for success, false for failure.

CompressBdAsync ⁽¹⁾

CkTask *CompressBdAsync(CkBinData &bd);

Introduced in version 11.0.0

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

CompressFile

bool CompressFile(const char *inFilename, const char *toPath);

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

Note: Both inFilename and toPath should be relative or absolute file paths (not just a path to a directory). For example someDir1/someDir2/myFile.txt or c:/someDir1/myFile.bz2.

Returns true for success, false for failure.

More Information and Examples

bz2 Compress File

CompressFileAsync ⁽¹⁾

CkTask *CompressFileAsync(const char *inFilename, const char *toPath);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

LoadTaskCaller

bool LoadTaskCaller(CkTask &task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

UncompressBd

bool UncompressBd(CkBinData &bd);

Introduced in version 11.0.0

BZ2 uncompress the contents of bd, which initially should contain the bytes of a .bz2 file. After uncompressing, the bd contains the original uncompressed content.

Returns true for success, false for failure.

UncompressBdAsync ⁽¹⁾

CkTask *UncompressBdAsync(CkBinData &bd);

Introduced in version 11.0.0

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

UncompressFile

bool UncompressFile(const char *inFilename, const char *toPath);

Unzips a .bz2 file.

Returns true for success, false for failure.

UncompressFileAsync ⁽¹⁾

CkTask *UncompressFileAsync(const char *inFilename, const char *toPath);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

Events

To implement an event callback, your application would define and implement a class that inherits from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.

For example:

  CkBz2 bz;

  MyBz2Progress callbackObj;

  bz.put_EventCallbackObject(&callbackObj);

MyBz2Progress example:

#include "CkBaseProgress.h"

class MyBz2Progress : public CkBaseProgress {

  public:
    MyBz2Progress();
    virtual ~MyBz2Progress();

    void AbortCheck(bool  *abort);

    void PercentDone(int pctDone, bool  *abort);

    void ProgressInfo(const char *name, const char *value);

    void TaskCompleted(CkTask &task);

};

AbortCheck

void AbortCheck(bool *abort);

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.

More Information and Examples

Chilkat Event Callback Examples

PercentDone

void PercentDone(int pctDone, bool *abort);

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.

More Information and Examples

Chilkat Event Callback Examples

ProgressInfo

void ProgressInfo(const char *name, const char *value);

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.

More Information and Examples

Chilkat Event Callback Examples

TaskCompleted

void TaskCompleted(CkTask &task);

Called from the background thread when an asynchronous task completes.

Deprecated

CompressFileToMem Deprecated

bool CompressFileToMem(const char *inFilename, CkByteData &outBytes);

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

Returns true for success, false for failure.

CompressFileToMemAsync Deprecated ⁽¹⁾

CkTask *CompressFileToMemAsync(const char *inFilename);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

CompressMemory Deprecated

bool CompressMemory(CkByteData &inData, CkByteData &outBytes);

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

Returns true for success, false for failure.

CompressMemoryAsync Deprecated ⁽¹⁾

CkTask *CompressMemoryAsync(CkByteData &inData);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

CompressMemToFile Deprecated

bool CompressMemToFile(CkByteData &inData, const char *toPath);

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

Returns true for success, false for failure.

CompressMemToFileAsync Deprecated ⁽¹⁾

CkTask *CompressMemToFileAsync(CkByteData &inData, const char *toPath);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

UncompressFileToMem Deprecated

bool UncompressFileToMem(const char *inFilename, CkByteData &outBytes);

Unzips a .bz2 file directly to memory.

Returns true for success, false for failure.

UncompressFileToMemAsync Deprecated ⁽¹⁾

CkTask *UncompressFileToMemAsync(const char *inFilename);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

UncompressMemory Deprecated

bool UncompressMemory(CkByteData &inData, CkByteData &outBytes);

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

Returns true for success, false for failure.

UncompressMemoryAsync Deprecated ⁽¹⁾

CkTask *UncompressMemoryAsync(CkByteData &inData);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

UncompressMemToFile Deprecated

bool UncompressMemToFile(CkByteData &inData, const char *toPath);

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

Returns true for success, false for failure.

UncompressMemToFileAsync Deprecated ⁽¹⁾

CkTask *UncompressMemToFileAsync(CkByteData &inData, const char *toPath);

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.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure