Bz2 C Reference Documentation

Bz2

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

Create/Dispose

HCkBz2 CkBz2_Create(void);

Creates an instance of the HCkBz2 object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkBz2_Dispose(HCkBz2 handle);

Objects created by calling CkBz2_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkBz2_Dispose.

Callback Functions

Callback Functions are Introduced in Chilkat v9.5.0.56

void CkBz2_setAbortCheck(HCkHttp cHandle, BOOL (*fnAbortCheck)());

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

C Example using Callback Functions

void CkBz2_setPercentDone(HCkHttp cHandle, BOOL (*fnPercentDone)(int pctDone));

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 callback is only called 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 methods 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).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkBz2_setProgressInfo(HCkHttp cHandle, void (*fnProgressInfo)(const char *name, const char *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkBz2_setTaskCompleted(HCkHttp cHandle, void (*fnTaskCompleted)(HCkTask hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

BOOL CkBz2_getAbortCurrent(HCkBz2 cHandle);

void CkBz2_putAbortCurrent(HCkBz2 cHandle, 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 CkBz2_getDebugLogFilePath(HCkBz2 cHandle, HCkString retval);

void CkBz2_putDebugLogFilePath(HCkBz2 cHandle, const char *newVal);

const char *CkBz2_debugLogFilePath(HCkBz2 cHandle);

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 CkBz2_getHeartbeatMs(HCkBz2 cHandle);

void CkBz2_putHeartbeatMs(HCkBz2 cHandle, int newVal);

To be documented soon...

void CkBz2_getLastErrorHtml(HCkBz2 cHandle, HCkString retval);

const char *CkBz2_lastErrorHtml(HCkBz2 cHandle);

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 CkBz2_getLastErrorText(HCkBz2 cHandle, HCkString retval);

const char *CkBz2_lastErrorText(HCkBz2 cHandle);

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 CkBz2_getLastErrorXml(HCkBz2 cHandle, HCkString retval);

const char *CkBz2_lastErrorXml(HCkBz2 cHandle);

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 CkBz2_getLastMethodSuccess(HCkBz2 cHandle);

void CkBz2_putLastMethodSuccess(HCkBz2 cHandle, 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 CkBz2_getUtf8(HCkBz2 cHandle);

void CkBz2_putUtf8(HCkBz2 cHandle, 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 CkBz2_getVerboseLogging(HCkBz2 cHandle);

void CkBz2_putVerboseLogging(HCkBz2 cHandle, 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 CkBz2_getVersion(HCkBz2 cHandle, HCkString retval);

const char *CkBz2_version(HCkBz2 cHandle);

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

Methods

BOOL CkBz2_CompressFile(HCkBz2 cHandle, const char *inFilename, const char *toPath);

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

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_CompressFileAsync(HCkBz2 cHandle, 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_CompressFileToMem(HCkBz2 cHandle, const char *inFilename, HCkByteData outBytes);

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

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_CompressFileToMemAsync(HCkBz2 cHandle, 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_CompressMemory(HCkBz2 cHandle, HCkByteData inData, HCkByteData outBytes);

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

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_CompressMemoryAsync(HCkBz2 cHandle, HCkByteData 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_CompressMemToFile(HCkBz2 cHandle, HCkByteData inData, const char *toPath);

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

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_CompressMemToFileAsync(HCkBz2 cHandle, HCkByteData 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_SaveLastError(HCkBz2 cHandle, 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 CkBz2_UncompressFile(HCkBz2 cHandle, const char *inFilename, const char *toPath);

Unzips a .bz2 file.

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_UncompressFileAsync(HCkBz2 cHandle, 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_UncompressFileToMem(HCkBz2 cHandle, const char *inFilename, HCkByteData outBytes);

Unzips a .bz2 file directly to memory.

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_UncompressFileToMemAsync(HCkBz2 cHandle, 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_UncompressMemory(HCkBz2 cHandle, HCkByteData inData, HCkByteData outBytes);

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

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_UncompressMemoryAsync(HCkBz2 cHandle, HCkByteData 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_UncompressMemToFile(HCkBz2 cHandle, HCkByteData inData, const char *toPath);

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

Returns TRUE for success, FALSE for failure.

HCkTask CkBz2_UncompressMemToFileAsync(HCkBz2 cHandle, HCkByteData 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.)

Returns NULL on failure

How to Run an Asynchronous Task

BOOL CkBz2_UnlockComponent(HCkBz2 cHandle, 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