Bz2 CkPython Reference Documentation
CkBz2
Current Version: 11.0.0
Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.
Object Creation
obj = chilkat.CkBz2()
Properties
AbortCurrent
boolVal = bz2.get_AbortCurrent();
bz2.put_AbortCurrent(boolVal);
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
# ckStr is a CkString
bz2.get_DebugLogFilePath(ckStr);
strVal = bz2.debugLogFilePath();
bz2.put_DebugLogFilePath(strVal);
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.
LastErrorHtml
# ckStr is a CkString
bz2.get_LastErrorHtml(ckStr);
strVal = bz2.lastErrorHtml();
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
# ckStr is a CkString
bz2.get_LastErrorText(ckStr);
strVal = bz2.lastErrorText();
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
# ckStr is a CkString
bz2.get_LastErrorXml(ckStr);
strVal = bz2.lastErrorXml();
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
boolVal = bz2.get_LastMethodSuccess();
bz2.put_LastMethodSuccess(boolVal);
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
boolVal = bz2.get_VerboseLogging();
bz2.put_VerboseLogging(boolVal);
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
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 None
on failure
CompressFile
# toPath is a string
status = bz2.CompressFile(inFilename, 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.
CompressFileAsync (1)
# inFilename is a string
# toPath is a string
ret_task = bz2.CompressFileAsync(inFilename, toPath);
Creates an asynchronous task to call the CompressFile method with the arguments provided.
Returns None
on failure
CompressFileToMem Deprecated
# outBytes is a CkByteData (output)
status = bz2.CompressFileToMem(inFilename, outData);
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 None
on failure
CompressMemory Deprecated
# outBytes is a CkByteData (output)
status = bz2.CompressMemory(inData, outData);
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 None
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)
# inData is a CkByteData
# toPath is a string
ret_task = bz2.CompressMemToFileAsync(inData, toPath);
Creates an asynchronous task to call the CompressMemToFile method with the arguments provided.
Returns None
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 None
on failure
UncompressFile
# toPath is a string
status = bz2.UncompressFile(inFilename, toPath);
UncompressFileAsync (1)
# inFilename is a string
# toPath is a string
ret_task = bz2.UncompressFileAsync(inFilename, toPath);
Creates an asynchronous task to call the UncompressFile method with the arguments provided.
Returns None
on failure
UncompressFileToMem Deprecated
# outBytes is a CkByteData (output)
status = bz2.UncompressFileToMem(inFilename, outData);
UncompressFileToMemAsync Deprecated (1)
Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.
Returns None
on failure
UncompressMemory Deprecated
# outBytes is a CkByteData (output)
status = bz2.UncompressMemory(inData, outData);
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 None
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)
# inData is a CkByteData
# toPath is a string
ret_task = bz2.UncompressMemToFileAsync(inData, toPath);
Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided.
Returns None
on failure