UnixCompress C# WinRT Reference Documentation

UnixCompress

UNIX (.Z) compression component.

Object Creation

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

Properties

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

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.

public int HeartbeatMs {get; set; }

The number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any method call prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

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.

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.

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.

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.

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.

public string Version {get; }

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

Methods

(awaitable) public IAsyncOperation<bool> CompressFileAsync(string inFilename, string destPath);

Compresses a file to create a UNIX compressed file (.Z). This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.

Returns true for success, false for failure.

(awaitable) public IAsyncOperation<byte[]> CompressFileToMemAsync(string inFilename);

Unix compresses a file to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns an empty byte array on failure

public bool CompressMemToFile(byte[] inData, string destPath);

Unix compresses and creates a .Z file from in-memory data. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

public byte[] CompressMemory(byte[] inData);

Compresses in-memory data to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns an empty byte array on failure

public byte[] CompressString(string inStr, string charset);

Compresses a string to an in-memory image of a .Z file. Prior to compression, the string is converted to the character encoding specified by charset. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns an empty byte array on failure

List of Valid Charsets

public bool CompressStringToFile(string inStr, string charset, string destPath);

Unix compresses and creates a .Z file from string data. The charset specifies the character encoding used for the byte representation of the characters when compressed. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns true for success, false for failure.

List of Valid Charsets

public bool IsUnlocked();

Returns true if the component has been unlocked. (For ActiveX, returns 1 if unlocked.)

public bool SaveLastError(string path);

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

Returns true for success, false for failure.

(awaitable) public IAsyncOperation<bool> UnTarZAsync(string zFilename, string destDir, bool bNoAbsolute);

Unpacks a .tar.Z file. The decompress and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring.

Returns true for success, false for failure.

(awaitable) public IAsyncOperation<bool> UncompressFileAsync(string inFilename, string destPath);

Uncompresses a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

(awaitable) public IAsyncOperation<byte[]> UncompressFileToMemAsync(string inFilename);

Uncompresses a .Z file directly to memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns an empty byte array on failure

(awaitable) public IAsyncOperation<string> UncompressFileToStringAsync(string zFilename, string charset);

Uncompresses a .Z file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc.

Returns null on failure

List of Valid Charsets

public bool UncompressMemToFile(byte[] inData, string destPath);

Uncompresses from an in-memory image of a .Z file to a file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

public byte[] UncompressMemory(byte[] inData);

Uncompresses from an in-memory image of a .Z file directly into memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns an empty byte array on failure

public string UncompressString(byte[] inCompressedData, string charset);

Uncompresses from an in-memory image of a .Z file directly to a string. The charset specifies the character encoding used to interpret the bytes resulting from the decompression. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns null on failure

List of Valid Charsets

public bool UnlockComponent(string unlockCode);

Unlocks the component allowing for the full functionality to be used.

Returns true for success, false for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

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

    }

public event AbortCheckEventHandler AbortCheck;

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.

Chilkat WinRT C# Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void unixcompress_AbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
            await m_dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
            {
	        // The event callback is not in the main UI thread.  To safely update UI elements, encapsulate
                // application code in this way.
            });
	}

To add an event handler:

Chilkat.UnixCompress unixcompress = new Chilkat.UnixCompress();
unixcompress.AbortCheck += unixcompress_AbortCheck;

public event BinaryDataEventHandler BinaryData;

Binary data provided by certain methods.

Chilkat WinRT C# Event Implementation

Args are passed using Chilkat.BinaryDataEventArgs

Event callback implementation:

private void unixcompress_BinaryData(object sender, Chilkat.BinaryDataEventArgs args)
	{
            await m_dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
            {
	        // The event callback is not in the main UI thread.  To safely update UI elements, encapsulate
                // application code in this way.
            });
	}

To add an event handler:

Chilkat.UnixCompress unixcompress = new Chilkat.UnixCompress();
unixcompress.BinaryData += unixcompress_BinaryData;

public event PercentDoneEventHandler PercentDone;

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

Chilkat WinRT C# Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void unixcompress_PercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
            await m_dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
            {
	        // The event callback is not in the main UI thread.  To safely update UI elements, encapsulate
                // application code in this way.
            });
	}

To add an event handler:

Chilkat.UnixCompress unixcompress = new Chilkat.UnixCompress();
unixcompress.PercentDone += unixcompress_PercentDone;

public event ProgressInfoEventHandler ProgressInfo;

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.

Chilkat WinRT C# Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void unixcompress_ProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
            await m_dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
            {
	        // The event callback is not in the main UI thread.  To safely update UI elements, encapsulate
                // application code in this way.
            });
	}

To add an event handler:

Chilkat.UnixCompress unixcompress = new Chilkat.UnixCompress();
unixcompress.ProgressInfo += unixcompress_ProgressInfo;

public event TaskCompletedEventHandler TaskCompleted;

Called in the background thread when an asynchronous task completes.

Chilkat WinRT C# Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void unixcompress_TaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
            await m_dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
            {
	        // The event callback is not in the main UI thread.  To safely update UI elements, encapsulate
                // application code in this way.
            });
	}

To add an event handler:

Chilkat.UnixCompress unixcompress = new Chilkat.UnixCompress();
unixcompress.TaskCompleted += unixcompress_TaskCompleted;

public event TextDataEventHandler TextData;

Text data provided by certain methods.

Chilkat WinRT C# Event Implementation

Args are passed using Chilkat.TextDataEventArgs

Event callback implementation:

private void unixcompress_TextData(object sender, Chilkat.TextDataEventArgs args)
	{
            await m_dispatcher.RunAsync(Windows.UI.Core.CoreDispatcherPriority.Normal, () =>
            {
	        // The event callback is not in the main UI thread.  To safely update UI elements, encapsulate
                // application code in this way.
            });
	}

To add an event handler:

Chilkat.UnixCompress unixcompress = new Chilkat.UnixCompress();
unixcompress.TextData += unixcompress_TextData;