Bz2 DataFlex Reference Documentation
Bz2
Current Version: 10.1.0
Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.
Object Creation
// (Dataflex programs use the 32-bit Chilkat ActiveX) Handle hoBz2
Get Create(RefClass(cComChilkatBz2)) to hoBz2
Properties
AbortCurrent
Procedure Set ComAbortCurrent Boolean value
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.)
topDebugLogFilePath
Procedure Set ComDebugLogFilePath String value
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to True. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
topLastErrorHtml
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
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
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
Procedure Set ComLastMethodSuccess Boolean value
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.
topLastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topVerboseLogging
Procedure Set ComVerboseLogging Boolean value
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.
topVersion
Methods
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
topCompressFileToMem
CompressFileToMemAsync (1)
Creates an asynchronous task to call the CompressFileToMem method with the arguments provided.
Returns null on failure
topCompressMemory
CompressMemoryAsync (1)
Creates an asynchronous task to call the CompressMemory method with the arguments provided.
Returns null on failure
topCompressMemToFile
BZip2 compresses and creates a .bz2 file from in-memory data.
Returns True for success, False for failure.
topCompressMemToFileAsync (1)
Creates an asynchronous task to call the CompressMemToFile method with the arguments provided.
Returns null on failure
topLoadTaskCaller
UncompressFile
UncompressFileAsync (1)
Creates an asynchronous task to call the UncompressFile method with the arguments provided.
Returns null on failure
topUncompressFileToMem
UncompressFileToMemAsync (1)
Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.
Returns null on failure
topUncompressMemory
UncompressMemoryAsync (1)
Creates an asynchronous task to call the UncompressMemory method with the arguments provided.
Returns null on failure
topUncompressMemToFile
Unzips from an in-memory image of a .bz2 file to a file.
Returns True for success, False for failure.
topUncompressMemToFileAsync (1)
Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided.
Returns null on failure
top