CkBz2 C++ Class Reference

CkBz2

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

Properties

CkBz2Progress *get_EventCallbackObject(void) const;
void put_EventCallbackObject(CkBz2Progress *progress);

To be documented soon...

void LastErrorHtml(CkString &str);

Error information in HTML format for the last method called.

void LastErrorText(CkString &str);

Error information in plain-text format for the last method called.

void LastErrorXml(CkString &str);

Error information in XML format for the last method called.

bool get_Utf8(void) const;
void put_Utf8(bool b);

To be documented soon...

Methods

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

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

Returns true for success, false for failure.

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

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

Returns false on failure.

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

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

Returns true for success, false for failure.

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

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

bool SaveLastError(const char * filename);

Saves the last error information to an XML formatted file.

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

Unzips a .bz2 file.

Returns true for success, false for failure.

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

Unzips a .bz2 file directly to memory.

Returns false on failure.

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

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

Returns true for success, false for failure.

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

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

Returns false on failure.

bool UnlockComponent(const char * regCode);

Unlocks the component allowing for the full functionality to be used. If a permanent (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

How UnlockComponent Works

const char * lastErrorHtml();

Error information in HTML format for the last method called.

Returns a null on failure

const char * lastErrorText();

Error information in plain-text format for the last method called.

Returns a null on failure

const char * lastErrorXml();

Error information in XML format for the last method called.

Returns a null on failure