CkBz2W Unicode C++ Reference Documentation

CkBz2W

Current Version: 10.1.0

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

Object Creation

// Local variable on the stack
CkBz2W obj;

// Dynamically allocate/delete
CkBz2W *pObj = new CkBz2W();
// ...
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.)

top
DebugLogFilePath
void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

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
top
HeartbeatMs
int get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any compress or decompress operation prior to completion. If HeartbeatMs is 0, no AbortCheck event callbacks will occur.

top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const wchar_t *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.

top
LastErrorText
void get_LastErrorText(CkString &str);
const wchar_t *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.

top
LastErrorXml
void get_LastErrorXml(CkString &str);
const wchar_t *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.

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

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

top
Version
void get_Version(CkString &str);
const wchar_t *version(void);

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

More Information and Examples
top

Methods

CompressFile
bool CompressFile(const wchar_t *inFilename, const wchar_t *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
top
CompressFileAsync (1)
CkTaskW *CompressFileAsync(const wchar_t *inFilename, const wchar_t *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

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

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

Returns true for success, false for failure.

top
CompressFileToMemAsync (1)
CkTaskW *CompressFileToMemAsync(const wchar_t *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

top
CompressMemory
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.

top
CompressMemoryAsync (1)
CkTaskW *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

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

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

Returns true for success, false for failure.

top
CompressMemToFileAsync (1)
CkTaskW *CompressMemToFileAsync(CkByteData &inData, const wchar_t *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

top
LoadTaskCaller
bool LoadTaskCaller(CkTaskW &task);
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
UncompressFile
bool UncompressFile(const wchar_t *inFilename, const wchar_t *toPath);

Unzips a .bz2 file.

Returns true for success, false for failure.

top
UncompressFileAsync (1)
CkTaskW *UncompressFileAsync(const wchar_t *inFilename, const wchar_t *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

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

Unzips a .bz2 file directly to memory.

Returns true for success, false for failure.

top
UncompressFileToMemAsync (1)
CkTaskW *UncompressFileToMemAsync(const wchar_t *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

top
UncompressMemory
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.

top
UncompressMemoryAsync (1)
CkTaskW *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

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

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

Returns true for success, false for failure.

top
UncompressMemToFileAsync (1)
CkTaskW *UncompressMemToFileAsync(CkByteData &inData, const wchar_t *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

top

Events

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

For example:

  CkBz2W bz;

  MyBz2ProgressW callbackObj;

  bz.put_EventCallbackObject(&callbackObj);

MyBz2ProgressW example:

#include "CkBaseProgressW.h"

class MyBz2ProgressW : public CkBaseProgressW {

  public:
    MyBz2ProgressW();
    virtual ~MyBz2ProgressW();

    void AbortCheck(bool  *abort);

    void PercentDone(int pctDone, bool  *abort);

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

    void TaskCompleted(CkTaskW &task);

};
AbortCheck
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.

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

top
ProgressInfo
void ProgressInfo(const wchar_t *name, const wchar_t *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.

top
TaskCompleted
void TaskCompleted(CkTaskW &task);

Called in the background thread when an asynchronous task completes.

top