CkBz2 C++ Reference Documentation

CkBz2

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

Properties

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

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

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.

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

To be documented soon...

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

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.

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

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

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

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.

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

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.

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

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

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.

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

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

Methods

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

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

Returns true for success, false for failure.

CkTask *CompressFileAsync(const char *inFilename, const char *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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

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.

CkTask *CompressFileToMemAsync(const char *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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

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.

CkTask *CompressMemoryAsync(CkByteData &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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

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.

CkTask *CompressMemToFileAsync(CkByteData &inData, const char *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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

bool SaveLastError(const char *path);

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

Returns true for success, false for failure.

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

Unzips a .bz2 file.

Returns true for success, false for failure.

CkTask *UncompressFileAsync(const char *inFilename, const char *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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

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

Unzips a .bz2 file directly to memory.

Returns true for success, false for failure.

CkTask *UncompressFileToMemAsync(const char *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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

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.

CkTask *UncompressMemoryAsync(CkByteData &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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

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.

CkTask *UncompressMemToFileAsync(CkByteData &inData, const char *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.

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

Returns NULL on failure

(C++) How to Run an Asynchronous Task

(MFC) How to Run an Asynchronous Task

bool UnlockComponent(const char *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

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 BinaryData(const void *data, unsigned int length);

    void PercentDone(int pctDone, bool  *abort);

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

    void TaskCompleted(CkTask &task);

    void TextData(const char *data);

};

void AbortCheck(bool *abort);

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.

void BinaryData(const void *data, unsigned int length);

Binary data provided by certain methods.

void PercentDone(int pctDone, bool *abort);

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

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

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.

void TaskCompleted(CkTask &task);

Called in the background thread when an asynchronous task completes.

void TextData(const char *data);

Text data provided by certain methods.