Bz2 Unicode C Reference Documentation
Bz2
Current Version: 11.0.0
Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.
Create/Dispose
HCkBz2W instance = CkBz2W_Create(); // ... CkBz2W_Dispose(instance);
Creates an instance of the HCkBz2W object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkBz2W_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 CkBz2W_Dispose.
Callback Functions
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.
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.
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.
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
AbortCurrent
void CkBz2W_putAbortCurrent(HCkBz2W cHandle, BOOL newVal);
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 CkBz2W_putDebugLogFilePath(HCkBz2W cHandle, const wchar_t *newVal);
const wchar_t *CkBz2W_debugLogFilePath(HCkBz2W cHandle);
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.
HeartbeatMs
void CkBz2W_putHeartbeatMs(HCkBz2W cHandle, 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.
topLastErrorHtml
const wchar_t *CkBz2W_lastErrorHtml(HCkBz2W cHandle);
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.
topLastErrorText
const wchar_t *CkBz2W_lastErrorText(HCkBz2W cHandle);
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.
LastErrorXml
const wchar_t *CkBz2W_lastErrorXml(HCkBz2W cHandle);
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.
topLastMethodSuccess
void CkBz2W_putLastMethodSuccess(HCkBz2W cHandle, 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.
VerboseLogging
void CkBz2W_putVerboseLogging(HCkBz2W 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.
Version
const wchar_t *CkBz2W_version(HCkBz2W cHandle);
Methods
CompressBd
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.
topCompressBdAsync (1)
Creates an asynchronous task to call the CompressBd method with the arguments provided.
Returns NULL on failure
CompressFile
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.
CompressFileAsync (1)
Creates an asynchronous task to call the CompressFile method with the arguments provided.
Returns NULL on failure
CompressFileToMem Deprecated
BZip2 compresses a file to an in-memory image of a .bz2 file.
Returns TRUE for success, FALSE for failure.
topCompressFileToMemAsync Deprecated (1)
Creates an asynchronous task to call the CompressFileToMem method with the arguments provided.
Returns NULL on failure
CompressMemory Deprecated
Compresses in-memory data to an in-memory image of a .bz2 file.
Returns TRUE for success, FALSE for failure.
topCompressMemoryAsync Deprecated (1)
Creates an asynchronous task to call the CompressMemory method with the arguments provided.
Returns NULL on failure
CompressMemToFile Deprecated
BZip2 compresses and creates a .bz2 file from in-memory data.
Returns TRUE for success, FALSE for failure.
topCompressMemToFileAsync Deprecated (1)
Creates an asynchronous task to call the CompressMemToFile method with the arguments provided.
Returns NULL on failure
LoadTaskCaller
UncompressBd
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.
topUncompressBdAsync (1)
Creates an asynchronous task to call the UncompressBd method with the arguments provided.
Returns NULL on failure
UncompressFile
UncompressFileAsync (1)
Creates an asynchronous task to call the UncompressFile method with the arguments provided.
Returns NULL on failure
UncompressFileToMem Deprecated
UncompressFileToMemAsync Deprecated (1)
Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.
Returns NULL on failure
UncompressMemory Deprecated
Unzips from an in-memory image of a .bz2 file directly into memory.
Returns TRUE for success, FALSE for failure.
topUncompressMemoryAsync Deprecated (1)
Creates an asynchronous task to call the UncompressMemory method with the arguments provided.
Returns NULL on failure
UncompressMemToFile Deprecated
Unzips from an in-memory image of a .bz2 file to a file.
Returns TRUE for success, FALSE for failure.
topUncompressMemToFileAsync Deprecated (1)
Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided.
Returns NULL on failure