Gzip

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

Specifies an optional comment string that can be embedded within the .gz when any Compress* method is called.

The compression level to be used when compressing. The default is 6, which is the typical value used for zip utility programs when compressing data. The compression level may range from 0 (no compression) to 9 (the most compression). The benefits of trying to increase compression may not be worth the added expense in compression time. In many cases (which is data dependent), the improvement in compression is minimal while the increase in computation time is significant.

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.

Optional extra-data that can be included within a .gz when a Compress* method is called.

The filename that is embedded within the .gz during any Compress* method call. When extracting from a .gz using applications such as WinZip, this will be the filename that is created.

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.

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.

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.

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.

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.

The same as the LastMod property, but allows the date/time to be get/set in RFC822 string format.

If set to true, the file produced by an Uncompress* method will use the current date/time for the last-modification date instead of the date/time found within the Gzip format.

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 of the component/library, such as "10.1.0"

In-place gzip the contents of binDat.

Returns true for success, false for failure.

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

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 null on failure

Compresses a file to create a GZip compressed file (.gz).

Returns true for success, false for failure.

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

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 null on failure

Compresses a file to create a GZip compressed file (.gz). inFilename is the actual filename on disk. embeddedFilename is the filename to be embedded in the .gz such that when it is un-gzipped, this is the name of the file that will be created.

Returns true for success, false for failure.

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

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 null on failure

Gzip compresses a file to an in-memory image of a .gz file.

Note: There is a 4GB size limitation. The compressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns an empty byte array on failure

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

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 null on failure

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

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns an empty byte array on failure

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

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 null on failure

Gzip compresses and creates a .gz file from in-memory data.

Returns true for success, false for failure.

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

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 null on failure

Gzip compresses a string and writes the output to a byte array. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns an empty byte array on failure

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

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 null on failure

The same as CompressString, except the binary output is returned in encoded string form according to the encoding. The encoding can be any of the following: "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns null on failure

Gzip compresses a string and writes the output to a .gz compressed file. The string is first converted to the charset specified by destCharset. Typical charsets are "utf-8", "iso-8859-1", "shift_JIS", etc.

Returns true for success, false for failure.

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

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 null on failure

Decodes an encoded string and returns the original data. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns an empty byte array on failure

Provides the ability to use the zip/gzip's deflate algorithm directly to compress a string. Internal to this method, inString is first converted to the charset specified by charsetName. The data is then compressed using the deflate compression algorithm. The binary output is then encoded according to outputEncoding. Possible values for outputEncoding are "hex", "base64", "url", and "quoted-printable".

Note: The output of this method is compressed data with no Gzip file format. Use the Compress* methods to produce Gzip file format output.

Returns null on failure

Encodes binary data to a printable string. The encoding mode is determined by encoding. It may be "base64", "hex", "quoted-printable", or "url".

Returns null on failure

Determines if the inGzFilename is a Gzip formatted file. Returns true if it is a Gzip formatted file, otherwise returns false.

Determines if the in-memory bytes (inGzData) contain a Gzip formatted file. Returns true if it is Gzip format, otherwise returns false.

Gets the last-modification date/time to be embedded within the .gz.

Returns null on failure

This the reverse of DeflateStringENC.

The input string is first decoded according to inputEncoding. (Possible values for inputEncoding are "hex", "base64", "url", and "quoted-printable".) The compressed data is then inflated, and the result is then converted from convertFromCharset (if necessary) to return a string.

Returns null on failure

Loads the caller of the task's async method.

Returns true for success, false for failure.

Reads a binary file into memory and returns the byte array. Note: This method does not parse a Gzip, it is only a convenience method for reading a binary file into memory.

Returns an empty byte array on failure

Sets the last-modification date/time to be embedded within the .gz when a Compress* method is called. If not explicitly set, the current system date/time is used.

Returns true for success, false for failure.

In-place ungzip the contents of binDat.

Returns true for success, false for failure.

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

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 null on failure

Un-Gzips a .gz file. The output filename is specified by the 2nd argument and not by the filename embedded within the .gz.

Returns true for success, false for failure.

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

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 null on failure

Un-Gzips a .gz file directly to memory.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns an empty byte array on failure

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

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 null on failure

Uncompresses a .gz 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

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

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 null on failure

Un-Gzips from an in-memory image of a .gz file directly into memory.

Note: There is a 4GB uncompressed size limitation. The uncompressed size of the file cannot be more than 4GB. Chilkat will be working to alleviate this limitation in the future.

Returns an empty byte array on failure

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

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 null on failure

Un-Gzips from an in-memory image of a .gz file to a file.

Returns true for success, false for failure.

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

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 null on failure

The reverse of CompressString.

The bytes in inData are uncompressed, then converted from inCharset (if necessary) to return a string.

Returns null on failure

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

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 null on failure

The same as UncompressString, except the compressed data is provided in encoded string form based on the value of encoding. The encoding can be "Base64", "modBase64", "Base32", "UU", "QP" (for quoted-printable), "URL" (for url-encoding), "Hex", "Q", "B", "url_oath", "url_rfc1738", "url_rfc2396", and "url_rfc3986".

Returns null on failure

Unpacks a .tar.gz file. The ungzip and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring. bNoAbsolute may be true or false. A value of true protects from untarring to absolute paths. (For example, imagine the trouble if the tar contains files with absolute paths beginning with /Windows/system32)

Returns true for success, false for failure.

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

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 null on failure

A convenience method for writing a binary byte array to a file.

Returns true for success, false for failure.

Converts base64-gzip .xfdl data to a decompressed XML string. The xfldData contains the base64 data. This method returns the decoded/decompressed XML string.

Returns null on failure

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 .NET Framework Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void gzip_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
gzip.OnAbortCheck += gzip_OnAbortCheck;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handleAbortCheck(out bool abort)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
// ...
Chilkat.Gzip.AbortCheck abortCheck = new Chilkat.Gzip.AbortCheck(handleAbortCheck);
gzip.setAbortCheckCb(abortCheck);

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 .NET Framework Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void gzip_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
gzip.OnPercentDone += gzip_OnPercentDone;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handlePercentDone(int pctDone, out bool abort)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
// ...
Chilkat.Gzip.PercentDone percentDone = new Chilkat.Gzip.PercentDone(handlePercentDone);
gzip.setPercentDoneCb(percentDone);

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 .NET Framework Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void gzip_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
gzip.OnProgressInfo += gzip_OnProgressInfo;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handleProgressInfo(string name, string value)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
// ...
Chilkat.Gzip.ProgressInfo progressInfo = new Chilkat.Gzip.ProgressInfo(handleProgressInfo);
gzip.setProgressInfoCb(progressInfo);

Called in the background thread when an asynchronous task completes.

Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void gzip_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
gzip.OnTaskCompleted += gzip_OnTaskCompleted;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handleTaskIdCompleted(int taskId)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Gzip gzip = new Chilkat.Gzip();
// ...
Chilkat.Gzip.TaskIdCompleted taskIdCompleted = new Chilkat.Gzip.TaskIdCompleted(handleTaskIdCompleted);
gzip.setTaskIdCompletedCb(taskIdCompleted);