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.

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.

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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

The last-modification date/time to be embedded within the .gz when a Compress* method is called. By default, the current system date/time is used. Uses the 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.

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

Returns true for success, false for 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.

Gzip compresses a file into an in-memory .gz file stored in bd, with a maximum compressed size of 4GB.

Returns true for success, false for failure.

Gzip compresses the byte representation of the string using the specified charset from charset (e.g., utf-8, iso-8859-1, or shift_JIS) and writes the compressed output to charset.

Returns true for success, false for 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.

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

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

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

Checks if the data in bd is in Gzip format. Returns true if it is, otherwise returns false.

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.

Sets the optional extra data that can be included within a .gz when a Compress* method is called. The extra binary data is passed in encoded form, where the encoding can be base64, hex, or ascii if simple text.

Returns true for success, false for failure.

In-place ungzip the contents of binDat.

Returns true for success, false for failure.

Un-Gzips from a GZip stored in bd to a file.

Returns true for success, false for 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.

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

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.

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