Bz2 C# 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

Chilkat.Bz2 obj = new Chilkat.Bz2();

Properties

AbortCurrent
public bool AbortCurrent {get; set; }
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
public string DebugLogFilePath {get; set; }

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
public int HeartbeatMs {get; set; }

To be documented soon...

top
LastErrorHtml
public string LastErrorHtml {get; }

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
public string LastErrorText {get; }

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
public string LastErrorXml {get; }

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
public bool LastMethodSuccess {get; set; }
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
public bool VerboseLogging {get; set; }

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
public string Version {get; }

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

top

Methods

CompressFile
(awaitable) public IAsyncOperation<bool> CompressFileAsyncAsync(string inFilename, string toPath);

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

Returns true for success, false for failure.

top
CompressFileToMem
(awaitable) public IAsyncOperation<byte[]> CompressFileToMemAsyncAsync(string inFilename);

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

Returns an empty byte array on failure

top
CompressMemory
(awaitable) public IAsyncOperation<byte[]> CompressMemoryAsyncAsync(byte[] inData);

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

Returns an empty byte array on failure

top
CompressMemToFile
(awaitable) public IAsyncOperation<bool> CompressMemToFileAsyncAsync(byte[] inData, string toPath);

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

Returns true for success, false for failure.

top
UncompressFile
(awaitable) public IAsyncOperation<bool> UncompressFileAsyncAsync(string inFilename, string toPath);

Unzips a .bz2 file.

Returns true for success, false for failure.

top
UncompressFileToMem
(awaitable) public IAsyncOperation<byte[]> UncompressFileToMemAsyncAsync(string inFilename);

Unzips a .bz2 file directly to memory.

Returns an empty byte array on failure

top
UncompressMemory
(awaitable) public IAsyncOperation<byte[]> UncompressMemoryAsyncAsync(byte[] inData);

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

Returns an empty byte array on failure

top
UncompressMemToFile
(awaitable) public IAsyncOperation<bool> UncompressMemToFileAsyncAsync(byte[] inData, string toPath);

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

Returns true for success, false for failure.

top
UnlockComponent
public bool UnlockComponent(string regCode);

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

Callbacks from asynchronous methods occur in a background thread. However, controls on the UI thread may only be accessed from the UI thread.Therefore, UI updates must be dispatched to the UI thread. One way to do this is as follows:

    public sealed partial class MainPage : Page
    {
        private Windows.UI.Core.CoreDispatcher m_dispatcher = null;

        public MainPage()
        {
            this.InitializeComponent();
            m_dispatcher = Windows.UI.Core.CoreWindow.GetForCurrentThread().Dispatcher;
        }


        async private void Http_ProgressInfo(object sender, Chilkat.ProgressInfoEventArgs eventArgs)
        {
            await m_dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
            {
                // Application code to update the UI goes here...
            });
        }

    }