Bz2 VB.NET WinRT 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 obj 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 Integer

To be documented soon...

top
LastErrorHtml
LastErrorHtml As String (ReadOnly)

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 (ReadOnly)

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 (ReadOnly)

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 (ReadOnly)

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

top

Methods

CompressFile
<Awaitable> Function CompressFileAsyncAsync(ByVal inFilename As String, ByVal toPath As String) As IAsyncOperation(Of Boolean)

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

Returns True for success, False for failure.

top
CompressFileToMem
<Awaitable> Function CompressFileToMemAsyncAsync(ByVal inFilename As String) As IAsyncOperation(Of Byte())

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

Returns an empty byte array on failure

top
CompressMemory
<Awaitable> Function CompressMemoryAsyncAsync(ByVal inData As Byte()) As IAsyncOperation(Of Byte())

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

Returns an empty byte array on failure

top
CompressMemToFile
<Awaitable> Function CompressMemToFileAsyncAsync(ByVal inData As Byte(), ByVal toPath As String) As IAsyncOperation(Of Boolean)

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

Returns True for success, False for failure.

top
UncompressFile
<Awaitable> Function UncompressFileAsyncAsync(ByVal inFilename As String, ByVal toPath As String) As IAsyncOperation(Of Boolean)

Unzips a .bz2 file.

Returns True for success, False for failure.

top
UncompressFileToMem
<Awaitable> Function UncompressFileToMemAsyncAsync(ByVal inFilename As String) As IAsyncOperation(Of Byte())

Unzips a .bz2 file directly to memory.

Returns an empty byte array on failure

top
UncompressMemory
<Awaitable> Function UncompressMemoryAsyncAsync(ByVal inData As Byte()) As IAsyncOperation(Of Byte())

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

Returns an empty byte array on failure

top
UncompressMemToFile
<Awaitable> Function UncompressMemToFileAsyncAsync(ByVal inData As Byte(), ByVal toPath As String) As IAsyncOperation(Of Boolean)

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

Returns True for success, False for failure.

top
UnlockComponent
Function UnlockComponent(ByVal 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