CkGzip C++ Reference Documentation

CkGzip

Current Version: 10.0.0

GZip compression component.

Object Creation

// Local variable on the stack
CkGzip obj;

// Dynamically allocate/delete
CkGzip *pObj = new CkGzip();
// ...
delete pObj;

Properties

AbortCurrent
bool get_AbortCurrent(void);
void put_AbortCurrent(bool newVal);
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.)

top
Comment
void get_Comment(CkString &str);
const char *comment(void);
void put_Comment(const char *ansiOrUtf8Str);

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

top
CompressionLevel
int get_CompressionLevel(void);
void put_CompressionLevel(int newVal);
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
void get_DebugLogFilePath(CkString &str);
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);

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.

More Information and Examples
top
ExtraData
void get_ExtraData(CkByteData &byteData);
void put_ExtraData(CkByteData &newVal);

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

top
Filename
void get_Filename(CkString &str);
const char *filename(void);
void put_Filename(const char *ansiOrUtf8Str);

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
HeartbeatMs
int get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

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.

top
LastErrorHtml
void get_LastErrorHtml(CkString &str);
const char *lastErrorHtml(void);

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
void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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
void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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
bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

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.

top
LastModStr
void get_LastModStr(CkString &str);
const char *lastModStr(void);
void put_LastModStr(const char *ansiOrUtf8Str);

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

top
UseCurrentDate
bool get_UseCurrentDate(void);
void put_UseCurrentDate(bool newVal);

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.

top
Utf8
bool get_Utf8(void);
void put_Utf8(bool newVal);

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

top
VerboseLogging
bool get_VerboseLogging(void);
void put_VerboseLogging(bool newVal);

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.

top
Version
void get_Version(CkString &str);
const char *version(void);

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

More Information and Examples
top

Methods

CompressBd
bool CompressBd(CkBinData &binDat);
Introduced in version 9.5.0.67

In-place gzip the contents of binDat.

Returns true for success, false for failure.

More Information and Examples
top
CompressBdAsync (1)
CkTask *CompressBdAsync(CkBinData &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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CompressFile
bool CompressFile(const char *inFilename, const char *destPath);

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

Returns true for success, false for failure.

More Information and Examples
top
CompressFileAsync (1)
CkTask *CompressFileAsync(const char *inFilename, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CompressFile2
bool CompressFile2(const char *inFilename, const char *embeddedFilename, const char *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 true for success, false for failure.

More Information and Examples
top
CompressFile2Async (1)
CkTask *CompressFile2Async(const char *inFilename, const char *embeddedFilename, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CompressFileToMem
bool CompressFileToMem(const char *inFilename, CkByteData &outData);

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

top
CompressFileToMemAsync (1)
CkTask *CompressFileToMemAsync(const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CompressMemory
bool CompressMemory(CkByteData &inData, CkByteData &outData);

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

top
CompressMemoryAsync (1)
CkTask *CompressMemoryAsync(CkByteData &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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CompressMemToFile
bool CompressMemToFile(CkByteData &inData, const char *destPath);

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

Returns true for success, false for failure.

top
CompressMemToFileAsync (1)
CkTask *CompressMemToFileAsync(CkByteData &inData, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CompressString
bool CompressString(const char *inStr, const char *destCharset, CkByteData &outBytes);

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

More Information and Examples
top
CompressStringAsync (1)
CkTask *CompressStringAsync(const char *inStr, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
CompressStringENC
bool CompressStringENC(const char *inStr, const char *charset, const char *encoding, CkString &outStr);
const char *compressStringENC(const char *inStr, const char *charset, const char *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 true for success, false for failure.

top
CompressStringToFile
bool CompressStringToFile(const char *inStr, const char *destCharset, const char *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 true for success, false for failure.

More Information and Examples
top
CompressStringToFileAsync (1)
CkTask *CompressStringToFileAsync(const char *inStr, const char *destCharset, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
Decode
bool Decode(const char *encodedStr, const char *encoding, CkByteData &outBytes);

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

top
DeflateStringENC
bool DeflateStringENC(const char *inString, const char *charsetName, const char *outputEncoding, CkString &outStr);
const char *deflateStringENC(const char *inString, const char *charsetName, const char *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 true for success, false for failure.

More Information and Examples
top
Encode
bool Encode(CkByteData &byteData, const char *encoding, CkString &outStr);
const char *encode(CkByteData &byteData, const char *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 true for success, false for failure.

top
ExamineFile
bool ExamineFile(const char *inGzFilename);

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

top
ExamineMemory
bool ExamineMemory(CkByteData &inGzData);

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

top
GetDt
CkDateTime *GetDt(void);

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

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
InflateStringENC
bool InflateStringENC(const char *inString, const char *convertFromCharset, const char *inputEncoding, CkString &outStr);
const char *inflateStringENC(const char *inString, const char *convertFromCharset, const char *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 true for success, false for failure.

top
LoadTaskCaller
bool LoadTaskCaller(CkTask &task);
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

top
ReadFile
bool ReadFile(const char *path, CkByteData &outBytes);

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

top
SetDt
bool SetDt(CkDateTime &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 true for success, false for failure.

top
UncompressBd
bool UncompressBd(CkBinData &binDat);
Introduced in version 9.5.0.67

In-place ungzip the contents of binDat.

Returns true for success, false for failure.

top
UncompressBdAsync (1)
CkTask *UncompressBdAsync(CkBinData &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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UncompressFile
bool UncompressFile(const char *srcPath, const char *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 true for success, false for failure.

More Information and Examples
top
UncompressFileAsync (1)
CkTask *UncompressFileAsync(const char *srcPath, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UncompressFileToMem
bool UncompressFileToMem(const char *inFilename, CkByteData &outData);

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

top
UncompressFileToMemAsync (1)
CkTask *UncompressFileToMemAsync(const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UncompressFileToString
bool UncompressFileToString(const char *gzFilename, const char *charset, CkString &outStr);
const char *uncompressFileToString(const char *gzFilename, const char *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 true for success, false for failure.

More Information and Examples
top
UncompressFileToStringAsync (1)
CkTask *UncompressFileToStringAsync(const char *gzFilename, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UncompressMemory
bool UncompressMemory(CkByteData &inData, CkByteData &outData);

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

top
UncompressMemoryAsync (1)
CkTask *UncompressMemoryAsync(CkByteData &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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UncompressMemToFile
bool UncompressMemToFile(CkByteData &inData, const char *destPath);

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

Returns true for success, false for failure.

top
UncompressMemToFileAsync (1)
CkTask *UncompressMemToFileAsync(CkByteData &inData, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UncompressString
bool UncompressString(CkByteData &inData, const char *inCharset, CkString &outStr);
const char *uncompressString(CkByteData &inData, const char *inCharset);

The reverse of CompressString.

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

Returns true for success, false for failure.

More Information and Examples
top
UncompressStringAsync (1)
CkTask *UncompressStringAsync(CkByteData &inData, const char *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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
UncompressStringENC
bool UncompressStringENC(const char *inStr, const char *charset, const char *encoding, CkString &outStr);
const char *uncompressStringENC(const char *inStr, const char *charset, const char *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 true for success, false for failure.

top
UnTarGz
bool UnTarGz(const char *tgzFilename, const char *destDir, bool 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 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.

top
UnTarGzAsync (1)
CkTask *UnTarGzAsync(const char *tgzFilename, const char *destDir, bool 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.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.

Returns NULL on failure

top
WriteFile
bool WriteFile(const char *path, CkByteData &binaryData);

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

Returns true for success, false for failure.

top
XfdlToXml
bool XfdlToXml(const char *xfldData, CkString &outStr);
const char *xfdlToXml(const char *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 true for success, false for failure.

top

Events

To implement an event callback, your application would define and implement a class that inherits from CkBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkBaseProgress base class.

For example:

  CkGzip gzip;

  MyGzipProgress callbackObj;

  gzip.put_EventCallbackObject(&callbackObj);

MyGzipProgress example:

#include "CkBaseProgress.h"

class MyGzipProgress : public CkBaseProgress {

  public:
    MyGzipProgress();
    virtual ~MyGzipProgress();

    void AbortCheck(bool  *abort);

    void PercentDone(int pctDone, bool  *abort);

    void ProgressInfo(const char *name, const char *value);

    void TaskCompleted(CkTask &task);

};
AbortCheck
void AbortCheck(bool *abort);

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.

top
PercentDone
void PercentDone(int pctDone, bool *abort);

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

top
ProgressInfo
void ProgressInfo(const char *name, const char *value);

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.

top
TaskCompleted
void TaskCompleted(CkTask &task);

Called in the background thread when an asynchronous task completes.

top