Bz2 Xojo Plugin Reference Documentation

Bz2

Current Version: 9.5.0.73

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

Object Creation

Dim bz2 As New Chilkat.Bz2

Properties

AbortCurrent
AbortCurrent As Boolean
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.)

top
DebugLogFilePath
DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
HeartbeatMs
HeartbeatMs As Int32

To be documented soon...

top
LastErrorHtml
LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
LastMethodSuccess As Boolean
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
VerboseLogging
VerboseLogging As Boolean

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.

top
Version
Version As String (read-only)

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

top

Methods

CompressFile
Function CompressFile(inFilename As String, toPath As String) As Boolean

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

Returns True for success, False for failure.

top
CompressFileAsync (1)
Function CompressFileAsync(inFilename As String, toPath As String) As Chilkat.Task

Creates an asynchronous task to call the CompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
CompressFileToMem
Function CompressFileToMem(inFilename As String) As MemoryBlock

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

Returns Nil on failure

top
CompressFileToMemAsync (1)
Function CompressFileToMemAsync(inFilename As String) As Chilkat.Task

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
CompressMemory
Function CompressMemory(inData As MemoryBlock) As MemoryBlock

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

Returns Nil on failure

top
CompressMemoryAsync (1)
Function CompressMemoryAsync(inData As MemoryBlock) As Chilkat.Task

Creates an asynchronous task to call the CompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
CompressMemToFile
Function CompressMemToFile(inData As MemoryBlock, toPath As String) As Boolean

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

Returns True for success, False for failure.

top
CompressMemToFileAsync (1)
Function CompressMemToFileAsync(inData As MemoryBlock, toPath As String) As Chilkat.Task

Creates an asynchronous task to call the CompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
SaveLastError
Function SaveLastError(path As String) As Boolean

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
UncompressFile
Function UncompressFile(inFilename As String, toPath As String) As Boolean

Unzips a .bz2 file.

Returns True for success, False for failure.

top
UncompressFileAsync (1)
Function UncompressFileAsync(inFilename As String, toPath As String) As Chilkat.Task

Creates an asynchronous task to call the UncompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
UncompressFileToMem
Function UncompressFileToMem(inFilename As String) As MemoryBlock

Unzips a .bz2 file directly to memory.

Returns Nil on failure

top
UncompressFileToMemAsync (1)
Function UncompressFileToMemAsync(inFilename As String) As Chilkat.Task

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
UncompressMemory
Function UncompressMemory(inData As MemoryBlock) As MemoryBlock

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

Returns Nil on failure

top
UncompressMemoryAsync (1)
Function UncompressMemoryAsync(inData As MemoryBlock) As Chilkat.Task

Creates an asynchronous task to call the UncompressMemory method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
UncompressMemToFile
Function UncompressMemToFile(inData As MemoryBlock, toPath As String) As Boolean

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

Returns True for success, False for failure.

top
UncompressMemToFileAsync (1)
Function UncompressMemToFileAsync(inData As MemoryBlock, toPath As String) As Chilkat.Task

Creates an asynchronous task to call the UncompressMemToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nil on failure

top
UnlockComponent
Function UnlockComponent(regCode As String) As Boolean

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

top

Events

To implement events, your application would define and implement a class that is a subclass of Chilkat.Bz2. Your custom class would implement (i.e. override) some or all of the event methods.

For example:

class MyBz2
    Inherits Chilkat.Bz2

    Function AbortCheck() As Boolean

    Sub BinaryData(data As MemoryBlock)

    Function PercentDone(pctDone As Int32) As Boolean

    Sub ProgressInfo(name As String, value As String)

    Sub TaskCompleted(task As Chilkat.Task)

    Sub TextData(data As String)


End Class
AbortCheck
Function AbortCheck() As Boolean

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

top
PercentDone
Function PercentDone(pctDone As Int32) As Boolean

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 event is only fired 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 operations (Chilkat method calls) 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).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to True will cause the method to abort and return a failed status (or whatever return value indicates failure).

top
ProgressInfo
Sub ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

top
TaskCompleted
Sub TaskCompleted(task As Chilkat.Task)

Called in the background thread when an asynchronous task completes.

top