Bz2 DataFlex Reference Documentation

Bz2

Current Version: 11.0.0

Requires Chilkat Bundle License

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

Function ComAbortCurrent Returns Boolean
Procedure Set ComAbortCurrent Boolean value

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

DebugLogFilePath

Function ComDebugLogFilePath Returns String
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.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastBinaryResult

Function ComLastBinaryResult Returns Variant

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.

LastErrorHtml

Function ComLastErrorHtml Returns String

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.

LastErrorText

Function ComLastErrorText Returns String

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

Function ComLastErrorXml Returns String

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.

LastMethodSuccess

Function ComLastMethodSuccess Returns Boolean
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.

LastStringResult

Function ComLastStringResult Returns String

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.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

Function ComLastStringResultLen Returns Integer

The length, in characters, of the string contained in the LastStringResult property.

VerboseLogging

Function ComVerboseLogging Returns Boolean
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.

Version

Function ComVersion Returns String

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressBd

Function ComCompressBd cComChilkatBinData bd Returns Boolean

Introduced in version 11.0.0

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.

CompressBdAsync ⁽¹⁾

Function ComCompressBdAsync cComChilkatBinData bd Returns cComChilkatTask

Introduced in version 11.0.0

Creates an asynchronous task to call the CompressBd method with the arguments provided.

Returns null on failure

CompressFile

Function ComCompressFile String inFilename String toPath Returns Boolean

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

bz2 Compress File

CompressFileAsync ⁽¹⁾

Function ComCompressFileAsync String inFilename String toPath Returns cComChilkatTask

Creates an asynchronous task to call the CompressFile method with the arguments provided.

Returns null on failure

CompressFileToMem

Function ComCompressFileToMem String inFilename Returns Variant

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

Returns null on failure

CompressFileToMemAsync ⁽¹⁾

Function ComCompressFileToMemAsync String inFilename Returns cComChilkatTask

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided.

Returns null on failure

CompressMemory

Function ComCompressMemory Variant inData Returns Variant

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

Returns null on failure

CompressMemoryAsync ⁽¹⁾

Function ComCompressMemoryAsync Variant inData Returns cComChilkatTask

Creates an asynchronous task to call the CompressMemory method with the arguments provided.

Returns null on failure

CompressMemToFile

Function ComCompressMemToFile Variant inData String toPath Returns Boolean

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

Returns True for success, False for failure.

CompressMemToFileAsync ⁽¹⁾

Function ComCompressMemToFileAsync Variant inData String toPath Returns cComChilkatTask

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided.

Returns null on failure

LoadTaskCaller

Function ComLoadTaskCaller cComChilkatTask task Returns Boolean

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

UncompressBd

Function ComUncompressBd cComChilkatBinData bd Returns Boolean

Introduced in version 11.0.0

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.

UncompressBdAsync ⁽¹⁾

Function ComUncompressBdAsync cComChilkatBinData bd Returns cComChilkatTask

Introduced in version 11.0.0

Creates an asynchronous task to call the UncompressBd method with the arguments provided.

Returns null on failure

UncompressFile

Function ComUncompressFile String inFilename String toPath Returns Boolean

Unzips a .bz2 file.

Returns True for success, False for failure.

UncompressFileAsync ⁽¹⁾

Function ComUncompressFileAsync String inFilename String toPath Returns cComChilkatTask

Creates an asynchronous task to call the UncompressFile method with the arguments provided.

Returns null on failure

UncompressFileToMem

Function ComUncompressFileToMem String inFilename Returns Variant

Unzips a .bz2 file directly to memory.

Returns null on failure

UncompressFileToMemAsync ⁽¹⁾

Function ComUncompressFileToMemAsync String inFilename Returns cComChilkatTask

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.

Returns null on failure

UncompressMemory

Function ComUncompressMemory Variant inData Returns Variant

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

Returns null on failure

UncompressMemoryAsync ⁽¹⁾

Function ComUncompressMemoryAsync Variant inData Returns cComChilkatTask

Creates an asynchronous task to call the UncompressMemory method with the arguments provided.

Returns null on failure

UncompressMemToFile

Function ComUncompressMemToFile Variant inData String toPath Returns Boolean

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

Returns True for success, False for failure.

UncompressMemToFileAsync ⁽¹⁾

Function ComUncompressMemToFileAsync Variant inData String toPath Returns cComChilkatTask

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided.

Returns null on failure