Gzip Tcl Reference Documentation

Gzip

GZip compression component.

Object Creation

set myGzip [new CkGzip]

Properties

AbortCurrent (boolean 1/0)

set boolVal [CkGzip_get_AbortCurrent $myGzip]
CkGzip_put_AbortCurrent $myGzip $boolVal

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

Comment (string)

# ckStr is a CkString
CkGzip_get_Comment $myGzip $ckStr
set strVal [CkGzip_get_comment $myGzip]
CkGzip_put_Comment $myGzip $strVal

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

CompressionLevel (integer)

set intVal [CkGzip_get_CompressionLevel $myGzip]
CkGzip_put_CompressionLevel $myGzip $intVal

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.

DebugLogFilePath (string)

# ckStr is a CkString
CkGzip_get_DebugLogFilePath $myGzip $ckStr
set strVal [CkGzip_get_debugLogFilePath $myGzip]
CkGzip_put_DebugLogFilePath $myGzip $strVal

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.

# ckBytes is a CkByteData
CkGzip_get_ExtraData $myGzip $ckBytes
CkGzip_put_ExtraData $myGzip $ckBytes

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

Filename (string)

# ckStr is a CkString
CkGzip_get_Filename $myGzip $ckStr
set strVal [CkGzip_get_filename $myGzip]
CkGzip_put_Filename $myGzip $strVal

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.

LastErrorHtml (string)

# ckStr is a CkString
CkGzip_get_LastErrorHtml $myGzip $ckStr
set strVal [CkGzip_get_lastErrorHtml $myGzip]

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.

LastErrorText (string)

# ckStr is a CkString
CkGzip_get_LastErrorText $myGzip $ckStr
set strVal [CkGzip_get_lastErrorText $myGzip]

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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml (string)

# ckStr is a CkString
CkGzip_get_LastErrorXml $myGzip $ckStr
set strVal [CkGzip_get_lastErrorXml $myGzip]

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.

LastMethodSuccess (boolean 1/0)

set boolVal [CkGzip_get_LastMethodSuccess $myGzip]
CkGzip_put_LastMethodSuccess $myGzip $boolVal

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.

LastModStr (string)

# ckStr is a CkString
CkGzip_get_LastModStr $myGzip $ckStr
set strVal [CkGzip_get_lastModStr $myGzip]
CkGzip_put_LastModStr $myGzip $strVal

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

UseCurrentDate (boolean 1/0)

set boolVal [CkGzip_get_UseCurrentDate $myGzip]
CkGzip_put_UseCurrentDate $myGzip $boolVal

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.

Utf8 (boolean 1/0)

set boolVal [CkGzip_get_Utf8 $myGzip]
CkGzip_put_Utf8 $myGzip $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

VerboseLogging (boolean 1/0)

set boolVal [CkGzip_get_VerboseLogging $myGzip]
CkGzip_put_VerboseLogging $myGzip $boolVal

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.

Version (string)

# ckStr is a CkString
CkGzip_get_Version $myGzip $ckStr
set strVal [CkGzip_get_version $myGzip]

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

Methods

# binDat is a CkBinData
set status [CkGzip_CompressBd $binDat]

Introduced in version 9.5.0.67

In-place gzip the contents of binDat.

Returns 1 for success, 0 for failure.

Gzip Compress In Memory and Base64 Encode

# returns a CkTask
# binDat is a CkBinData
set ret_task [CkGzip_CompressBdAsync $binDat]

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

How to Run an Asynchronous Task

# inFilename is a string
# destPath is a string
set status [CkGzip_CompressFile $inFilename $destPath]

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

Returns 1 for success, 0 for failure.

# returns a CkTask
# inFilename is a string
# destPath is a string
set ret_task [CkGzip_CompressFileAsync $inFilename $destPath]

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

How to Run an Asynchronous Task

# inFilename is a string
# embeddedFilename is a string
# destPath is a string
set status [CkGzip_CompressFile2 $inFilename $embeddedFilename $destPath]

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.

# returns a CkTask
# inFilename is a string
# embeddedFilename is a string
# destPath is a string
set ret_task [CkGzip_CompressFile2Async $inFilename $embeddedFilename $destPath]

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

How to Run an Asynchronous Task

# inFilename is a string
# outData is a CkByteData (output)
set status [CkGzip_CompressFileToMem $inFilename $outData]

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

Returns 1 for success, 0 for failure.

# returns a CkTask
# inFilename is a string
set ret_task [CkGzip_CompressFileToMemAsync $inFilename]

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

Returns NULL on failure

How to Run an Asynchronous Task

# inData is a CkByteData
# outData is a CkByteData (output)
set status [CkGzip_CompressMemory $inData $outData]

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

Returns 1 for success, 0 for failure.

# returns a CkTask
# inData is a CkByteData
set ret_task [CkGzip_CompressMemoryAsync $inData]

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

Returns NULL on failure

How to Run an Asynchronous Task

# inData is a CkByteData
# destPath is a string
set status [CkGzip_CompressMemToFile $inData $destPath]

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

Returns 1 for success, 0 for failure.

# returns a CkTask
# inData is a CkByteData
# destPath is a string
set ret_task [CkGzip_CompressMemToFileAsync $inData $destPath]

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

Returns NULL on failure

How to Run an Asynchronous Task

# inStr is a string
# destCharset is a string
# outBytes is a CkByteData (output)
set status [CkGzip_CompressString $inStr $destCharset $outData]

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

Full List of Charset Names

# returns a CkTask
# inStr is a string
# destCharset is a string
set ret_task [CkGzip_CompressStringAsync $inStr $destCharset]

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

Returns NULL on failure

How to Run an Asynchronous Task

# inStr is a string
# charset is a string
# encoding is a string
# outStr is a CkString (output)
set status [CkGzip_CompressStringENC $inStr $charset $encoding $outStr]
set retStr [CkGzip_compressStringENC $myGzip $inStr $charset $encoding]

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

# inStr is a string
# destCharset is a string
# destPath is a string
set status [CkGzip_CompressStringToFile $inStr $destCharset $destPath]

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.

Full List of Charset Names

# returns a CkTask
# inStr is a string
# destCharset is a string
# destPath is a string
set ret_task [CkGzip_CompressStringToFileAsync $inStr $destCharset $destPath]

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

How to Run an Asynchronous Task

# encodedStr is a string
# encoding is a string
# outBytes is a CkByteData (output)
set status [CkGzip_Decode $encodedStr $encoding $outData]

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

# inString is a string
# charsetName is a string
# outputEncoding is a string
# outStr is a CkString (output)
set status [CkGzip_DeflateStringENC $inString $charsetName $outputEncoding $outStr]
set retStr [CkGzip_deflateStringENC $myGzip $inString $charsetName $outputEncoding]

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

Full List of Charset Names

# byteData is a CkByteData
# encoding is a string
# outStr is a CkString (output)
set status [CkGzip_Encode $byteData $encoding $outStr]
set retStr [CkGzip_encode $myGzip $byteData $encoding]

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

Returns 1 for success, 0 for failure.

# inGzFilename is a string
set retBool [CkGzip_ExamineFile $inGzFilename]

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

# inGzData is a CkByteData
set retBool [CkGzip_ExamineMemory $inGzData]

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

# returns a CkDateTime
set ret_ckDateTime [CkGzip_GetDt]

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

Returns NULL on failure

# inString is a string
# convertFromCharset is a string
# inputEncoding is a string
# outStr is a CkString (output)
set status [CkGzip_InflateStringENC $inString $convertFromCharset $inputEncoding $outStr]
set retStr [CkGzip_inflateStringENC $myGzip $inString $convertFromCharset $inputEncoding]

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

set retBool [CkGzip_IsUnlocked]

Returns 1 if the component has been unlocked.

# path is a string
# outBytes is a CkByteData (output)
set status [CkGzip_ReadFile $path $outData]

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

# path is a string
set status [CkGzip_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

# dt is a CkDateTime
set status [CkGzip_SetDt $dt]

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.

# binDat is a CkBinData
set status [CkGzip_UncompressBd $binDat]

Introduced in version 9.5.0.67

In-place ungzip the contents of binDat.

Returns 1 for success, 0 for failure.

# returns a CkTask
# binDat is a CkBinData
set ret_task [CkGzip_UncompressBdAsync $binDat]

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

How to Run an Asynchronous Task

# srcPath is a string
# destPath is a string
set status [CkGzip_UncompressFile $srcPath $destPath]

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.

GZip Decompress File

# returns a CkTask
# srcPath is a string
# destPath is a string
set ret_task [CkGzip_UncompressFileAsync $srcPath $destPath]

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

How to Run an Asynchronous Task

# inFilename is a string
# outData is a CkByteData (output)
set status [CkGzip_UncompressFileToMem $inFilename $outData]

Un-Gzips a .gz file directly to memory.

Returns 1 for success, 0 for failure.

# returns a CkTask
# inFilename is a string
set ret_task [CkGzip_UncompressFileToMemAsync $inFilename]

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

Returns NULL on failure

How to Run an Asynchronous Task

# gzFilename is a string
# charset is a string
# outStr is a CkString (output)
set status [CkGzip_UncompressFileToString $gzFilename $charset $outStr]
set retStr [CkGzip_uncompressFileToString $myGzip $gzFilename $charset]

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

List of Valid Charsets

# returns a CkTask
# gzFilename is a string
# charset is a string
set ret_task [CkGzip_UncompressFileToStringAsync $gzFilename $charset]

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

How to Run an Asynchronous Task

# inData is a CkByteData
# outData is a CkByteData (output)
set status [CkGzip_UncompressMemory $inData $outData]

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

Returns 1 for success, 0 for failure.

# returns a CkTask
# inData is a CkByteData
set ret_task [CkGzip_UncompressMemoryAsync $inData]

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

Returns NULL on failure

How to Run an Asynchronous Task

# inData is a CkByteData
# destPath is a string
set status [CkGzip_UncompressMemToFile $inData $destPath]

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

Returns 1 for success, 0 for failure.

# returns a CkTask
# inData is a CkByteData
# destPath is a string
set ret_task [CkGzip_UncompressMemToFileAsync $inData $destPath]

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

Returns NULL on failure

How to Run an Asynchronous Task

# inData is a CkByteData
# inCharset is a string
# outStr is a CkString (output)
set status [CkGzip_UncompressString $inData $inCharset $outStr]
set retStr [CkGzip_uncompressString $myGzip $inData $inCharset]

The reverse of CompressString.

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

Returns 1 for success, 0 for failure.

Full List of Charset Names

# returns a CkTask
# inData is a CkByteData
# inCharset is a string
set ret_task [CkGzip_UncompressStringAsync $inData $inCharset]

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

Returns NULL on failure

How to Run an Asynchronous Task

# inStr is a string
# charset is a string
# encoding is a string
# outStr is a CkString (output)
set status [CkGzip_UncompressStringENC $inStr $charset $encoding $outStr]
set retStr [CkGzip_uncompressStringENC $myGzip $inStr $charset $encoding]

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

# unlockCode is a string
set status [CkGzip_UnlockComponent $unlockCode]

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

Returns 1 for success, 0 for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Purchased Unlock Code

LastErrorText Standard Information

# tgzFilename is a string
# destDir is a string
# bNoAbsolute is a boolean
set status [CkGzip_UnTarGz $tgzFilename $destDir $bNoAbsolute]

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.

# returns a CkTask
# tgzFilename is a string
# destDir is a string
# bNoAbsolute is a boolean
set ret_task [CkGzip_UnTarGzAsync $tgzFilename $destDir $bNoAbsolute]

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

How to Run an Asynchronous Task

# path is a string
# binaryData is a CkByteData
set status [CkGzip_WriteFile $path $binaryData]

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

Returns 1 for success, 0 for failure.

# xfldData is a string
# outStr is a CkString (output)
set status [CkGzip_XfdlToXml $xfldData $outStr]
set retStr [CkGzip_xfdlToXml $myGzip $xfldData]

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