Gzip PureBasic Reference Documentation

Gzip

Current Version: 9.5.0.73

GZip compression component.

Object Creation

obj.i = CkGzip::ckCreate()

; Make sure to dispose of the object when finished like this:
CkGzip::ckDispose(obj);

Properties

AbortCurrent
Declare.i ckAbortCurrent(obj.i)
Declare setCkAbortCurrent(obj.i, value.i)
Introduced in version 9.5.0.58

When set to 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. 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
Comment
Declare.s ckComment(obj.i)
Declare setCkComment(obj.i, value.s)

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

top
CompressionLevel
Declare.i ckCompressionLevel(obj.i)
Declare setCkCompressionLevel(obj.i, value.i)
Introduced in version 9.5.0.50

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.

top
DebugLogFilePath
Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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
Filename
Declare.s ckFilename(obj.i)
Declare setCkFilename(obj.i, value.s)

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.

top
LastErrorHtml
Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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
Declare.s ckLastErrorText(obj.i) ; (read-only)

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
Declare.s ckLastErrorXml(obj.i) ; (read-only)

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
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastModStr
Declare.s ckLastModStr(obj.i)
Declare setCkLastModStr(obj.i, value.s)

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

top
UseCurrentDate
Declare.i ckUseCurrentDate(obj.i)
Declare setCkUseCurrentDate(obj.i, value.i)

If set to 1, 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.

top
VerboseLogging
Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Declare.s ckVersion(obj.i) ; (read-only)

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

top

Methods

CompressBd
Declare.i ckCompressBd(obj.i, binDat.i)
Introduced in version 9.5.0.67

In-place gzip the contents of binDat.

Returns 1 for success, 0 for failure.

More Information and Examples
top
CompressBdAsync (1)
Declare.i ckCompressBdAsync(obj.i, binDat.i)
Introduced in version 9.5.0.67

Creates an asynchronous task to call the CompressBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
CompressFile
Declare.i ckCompressFile(obj.i, inFilename.s, destPath.s)

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

Returns 1 for success, 0 for failure.

top
CompressFileAsync (1)
Declare.i ckCompressFileAsync(obj.i, inFilename.s, destPath.s)

Creates an asynchronous task to call the CompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
CompressFile2
Declare.i ckCompressFile2(obj.i, inFilename.s, embeddedFilename.s, destPath.s)

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 1 for success, 0 for failure.

top
CompressFile2Async (1)
Declare.i ckCompressFile2Async(obj.i, inFilename.s, embeddedFilename.s, destPath.s)

Creates an asynchronous task to call the CompressFile2 method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
CompressStringENC
Declare.s ckCompressStringENC(obj.i, inStr.s, charset.s, encoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
CompressStringToFile
Declare.i ckCompressStringToFile(obj.i, inStr.s, destCharset.s, destPath.s)

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 1 for success, 0 for failure.

More Information and Examples
top
CompressStringToFileAsync (1)
Declare.i ckCompressStringToFileAsync(obj.i, inStr.s, destCharset.s, destPath.s)

Creates an asynchronous task to call the CompressStringToFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
DeflateStringENC
Declare.s ckDeflateStringENC(obj.i, inString.s, charsetName.s, outputEncoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples
top
ExamineFile
Declare.i ckExamineFile(obj.i, inGzFilename.s)

Determines if the inGzFilename is a Gzip formatted file. Returns 1 if it is a Gzip formatted file, otherwise returns 0.

top
GetDt
Declare.i ckGetDt(obj.i)

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

Returns 0 on failure

top
InflateStringENC
Declare.s ckInflateStringENC(obj.i, inString.s, convertFromCharset.s, inputEncoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
IsUnlocked
Declare.i ckIsUnlocked(obj.i)

Returns 1 if the component has been unlocked.

top
SaveLastError
Declare.i ckSaveLastError(obj.i, path.s)

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

Returns 1 for success, 0 for failure.

top
SetDt
Declare.i ckSetDt(obj.i, dt.i)

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 1 for success, 0 for failure.

top
UncompressBd
Declare.i ckUncompressBd(obj.i, binDat.i)
Introduced in version 9.5.0.67

In-place ungzip the contents of binDat.

Returns 1 for success, 0 for failure.

top
UncompressBdAsync (1)
Declare.i ckUncompressBdAsync(obj.i, binDat.i)
Introduced in version 9.5.0.67

Creates an asynchronous task to call the UncompressBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
UncompressFile
Declare.i ckUncompressFile(obj.i, srcPath.s, destPath.s)

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
UncompressFileAsync (1)
Declare.i ckUncompressFileAsync(obj.i, srcPath.s, destPath.s)

Creates an asynchronous task to call the UncompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
UncompressFileToString
Declare.s ckUncompressFileToString(obj.i, gzFilename.s, charset.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples
top
UncompressFileToStringAsync (1)
Declare.i ckUncompressFileToStringAsync(obj.i, gzFilename.s, charset.s)

Creates an asynchronous task to call the UncompressFileToString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
UncompressStringENC
Declare.s ckUncompressStringENC(obj.i, inStr.s, charset.s, encoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
UnlockComponent
Declare.i ckUnlockComponent(obj.i, unlockCode.s)

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

Returns 1 for success, 0 for failure.

top
UnTarGz
Declare.i ckUnTarGz(obj.i, tgzFilename.s, destDir.s, bNoAbsolute.l)

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 1 or 0. A value of 1 protects from untarring to absolute paths. (For example, imagine the trouble if the tar contains files with absolute paths beginning with /Windows/system32)

Returns 1 for success, 0 for failure.

top
UnTarGzAsync (1)
Declare.i ckUnTarGzAsync(obj.i, tgzFilename.s, destDir.s, bNoAbsolute.l)

Creates an asynchronous task to call the UnTarGz method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

top
XfdlToXml
Declare.s ckXfdlToXml(obj.i, xfldData.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top