Gzip C++ Reference Documentation
CkGzip
Current Version: 11.4.0
This class provides functionality for working with GZIP compression in both file-based and in-memory scenarios. It supports compressing and decompressing:
- Files (
.gz,.tar.gz) - Strings (with charset conversion)
- Binary data (
byte[],BinData) - Encoded data (Base64, Hex, etc.)
It also allows embedding metadata such as filenames, timestamps, and comments within the GZIP format.
For an extended overview, see Gzip Class Overview.
Object Creation
// Local variable on the stack CkGzip obj; // Dynamically allocate/delete CkGzip *pObj = new CkGzip(); // ... delete pObj;
Properties
AbortCurrent
void put_AbortCurrent(bool newVal);
Set this property to true
If no method is currently running, the property is automatically reset to falsefalse
Comment
const char *comment(void);
void put_Comment(const char *ansiOrUtf8Str);
An optional comment to embed in the Gzip file when a Compress* method is called.
CompressionLevel
void put_CompressionLevel(int newVal);
Controls the compression level used when creating Gzip data. The value can range from
0 to 9.
0= no compression9= maximum compression
The default value is 6, which is a typical balance between compression size and speed.
Higher levels may take significantly more CPU time while producing only slightly smaller output,
depending on the data.
DebugLogFilePath
const char *debugLogFilePath(void);
void put_DebugLogFilePath(const char *ansiOrUtf8Str);
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.
Filename
const char *filename(void);
void put_Filename(const char *ansiOrUtf8Str);
The filename to embed in the Gzip file when a Compress* method is called.
Some Gzip extraction tools use this embedded filename as the default output filename.
HeartbeatMs
void put_HeartbeatMs(int newVal);
Specifies the interval, in milliseconds, between AbortCheck event callbacks.
These callbacks allow an application to cancel certain long-running operations before they finish.
The default value is 0, which means no AbortCheck callbacks are triggered.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
void put_LastMethodSuccess(bool newVal);
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.
LastModStr
const char *lastModStr(void);
void put_LastModStr(const char *ansiOrUtf8Str);
Specifies the last-modified date/time to embed in the Gzip file when a
Compress* method is called.
The value must be provided as an RFC 822 formatted date/time string.
Example:
Tue, 15 Nov 1994 12:45:26 GMT
If this property is not set, the current system date/time is used automatically.
topUseCurrentDate
void put_UseCurrentDate(bool newVal);
Controls the last-modified date/time assigned to files created by Uncompress* methods.
When set to true
Utf8
void put_Utf8(bool newVal);
When set to true, all const char * arguments and return values are interpreted as UTF-8 strings. When set to false, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is true. Before v11.0.0, it was false.
VerboseLogging
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.
Version
Methods
CompressBd
Compresses the contents of a BinData object in place, replacing the original data
with Gzip-compressed data.
Returns true for success, false for failure.
CompressBdAsync (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressFile
Compresses a file and writes the result as a Gzip file, typically with a .gz extension.
Returns true for success, false for failure.
CompressFileAsync (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressFile2
Compresses a file and writes the result as a Gzip file, while allowing a different filename to be embedded inside the Gzip data.
The inFilename parameter is the actual file on disk. The
srcPath parameter is the filename stored in the Gzip header and may be used
by extraction tools as the output filename.
Returns true for success, false for failure.
CompressFile2Async (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressFileBd
Compresses a file and stores the resulting Gzip data in a BinData object.
The compressed output is held in memory. The maximum compressed size is 4 GB.
Returns true for success, false for failure.
CompressFileBdAsync (1)
Creates an asynchronous task to call the CompressFileBd 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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressSb
Compresses the text contained in a StringBuilder and writes the Gzip-compressed
result to a BinData object.
Before compression, the string is converted to bytes using the specified character set, such as
utf-8, iso-8859-1, or shift_JIS.
Returns true for success, false for failure.
CompressSbAsync (1)
Creates an asynchronous task to call the CompressSb 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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressStringENC
const char *compressStringENC(const char *inStr, const char *charset, const char *encoding);
Compresses a string and returns the Gzip-compressed data as an encoded string.
The input string is first converted to bytes using the specified character set. The compressed
binary data is then encoded using the requested encoding, such as base64,
hex, url, base32, or quoted-printable.
Returns true for success, false for failure.
CompressStringToFile
Compresses a string and writes the resulting Gzip data to a file.
The string is first converted to bytes using the character set specified by
destCharset.
Returns true for success, false for failure.
CompressStringToFileAsync (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
ExamineFile
Checks whether the specified file contains Gzip-formatted data.
Returns truefalse
IsGzip
Checks whether the data contained in a BinData object is in Gzip format.
Returns truefalse
LoadTaskCaller
SetDt
Sets the last-modified date/time to embed in the Gzip file when a Compress*
method is called.
If no date/time is explicitly set, the current system date/time is used.
Returns true for success, false for failure.
SetExtraData
Sets optional extra binary data to include in the Gzip header when a Compress*
method is called.
The data is passed as an encoded string. Supported encodings include base64,
hex, ascii, and many others.
Returns true for success, false for failure.
UncompressBd
Decompresses Gzip data contained in a BinData object in place, replacing the
compressed data with the uncompressed data.
Returns true for success, false for failure.
topUncompressBdAsync (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UncompressBdToFile
Decompresses Gzip data stored in a BinData object and writes the result to a file.
Returns true for success, false for failure.
topUncompressBdToFileAsync (1)
Creates an asynchronous task to call the UncompressBdToFile 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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UncompressFile
Decompresses a Gzip file and writes the result to the specified output path.
The output filename is provided by the caller. The filename embedded in the Gzip data is not used.
Returns true for success, false for failure.
UncompressFileAsync (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UncompressFileToString
const char *uncompressFileToString(const char *srcPath, const char *charset);
Decompresses a Gzip file that contains text and returns the uncompressed text as a string.
The charset parameter specifies the character encoding of the uncompressed text,
such as utf-8, iso-8859-1, windows-1252,
shift_JIS, big5, etc.
Returns true for success, false for failure.
UncompressFileToStringAsync (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UncompressStringENC
const char *uncompressStringENC(const char *inStr, const char *charset, const char *encoding);
Decompresses Gzip data provided as an encoded string and returns the uncompressed result as text.
The input string is first decoded using the specified encoding, such as base64,
hex, url, base32, quoted-printable, etc. The decoded
Gzip data is then decompressed and converted to text using the specified character set.
Returns true for success, false for failure.
UnTarGz
Extracts a .tar.gz archive to a directory.
The Gzip decompression and TAR extraction are performed in streaming mode. No temporary files are created, and memory usage remains small and constant.
If bNoAbsolute is true
Returns true for success, false for failure.
topUnTarGzAsync (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
XfdlToXml
const char *xfdlToXml(const char *xfldData);
Converts base64-encoded, Gzip-compressed XFDL data to XML text.
The input contains base64 data. The method decodes it, decompresses the Gzip data, and returns the resulting XML string.
XFDL (Extensible Forms Description Language) is an XML-based format used to define secure, interactive electronic forms—often including digital signatures and integrity protections—commonly used in government and enterprise applications.
Returns true for success, false for failure.
topEvents
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
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
PercentDone
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.
ProgressInfo
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
TaskCompleted
Called from the background thread when an asynchronous task completes.
Deprecated
CompressFileToMem Deprecated
Compresses a file and returns the resulting Gzip data as a byte array.
The compressed output is held in memory and has a maximum size limit of 4 GB.
Returns true for success, false for failure.
topCompressFileToMemAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressMemory Deprecated
Compresses a byte array and returns the result as an in-memory Gzip image.
The uncompressed input data must not exceed 4 GB.
Returns true for success, false for failure.
topCompressMemoryAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressMemToFile Deprecated
Compresses a byte array and writes the resulting Gzip data to a file.
Returns true for success, false for failure.
topCompressMemToFileAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
CompressString Deprecated
Compresses a string and returns the Gzip-compressed data as a byte array.
The string is first converted to bytes using the character set specified by
destCharset. Common values include utf-8,
iso-8859-1, and shift_JIS.
Returns true for success, false for failure.
CompressStringAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
Decode Deprecated
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.
topDeflateStringENC
const char *deflateStringENC(const char *inString, const char *charsetName, const char *outputEncoding);
Compresses a string using the raw deflate algorithm and returns the compressed data as an encoded string.
The input string is first converted to bytes using the specified character set. The compressed
binary data is then encoded using the requested output encoding, such as hex,
base64, url, or quoted-printable.
Important: This method produces raw deflate-compressed data, not Gzip-format data.
Use the Compress* methods when Gzip format output is required.
Returns true for success, false for failure.
Encode Deprecated
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.
topExamineMemory Deprecated
Checks whether the provided byte array contains Gzip-formatted data.
Returns truefalse
GetDt
Applications should instead access the LastModStr property.
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
InflateStringENC
const char *inflateStringENC(const char *inString, const char *convertFromCharset, const char *inputEncoding);
Decompresses data previously compressed with DeflateStringENC.
The input string is first decoded using the specified input encoding, such as
hex, base64, url, or
quoted-printable. The resulting compressed bytes are then inflated, and the
final bytes are converted to a string using the specified character set.
Returns true for success, false for failure.
topReadFile Deprecated
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.
topUncompressFileToMem Deprecated
Decompresses a Gzip file and returns the uncompressed data as a byte array.
The uncompressed output is held in memory and must not exceed 4 GB.
Returns true for success, false for failure.
topUncompressFileToMemAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UncompressMemory Deprecated
Decompresses an in-memory Gzip image and returns the uncompressed data as a byte array.
The uncompressed output is held in memory and must not exceed 4 GB.
Returns true for success, false for failure.
topUncompressMemoryAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UncompressMemToFile Deprecated
Decompresses an in-memory Gzip image and writes the uncompressed data to a file.
Returns true for success, false for failure.
topUncompressMemToFileAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
UncompressString Deprecated
const char *uncompressString(CkByteData &inData, const char *inCharset);
Decompresses Gzip-compressed data and returns the result as a string.
After decompression, the result is raw binary data (a sequence of bytes). These bytes are then
interpreted as text using the specified character set (such as utf-8,
iso-8859-1, etc.) to produce the final string.
Internally, Chilkat converts the byte sequence to a string by interpreting the bytes according
to the specified character set. For example, if utf-8 is specified, the bytes are
treated as the UTF-8 byte representation of text and decoded into the internal string format
used by the programming language.
It is important that the character set matches the one originally used when the data was compressed. If the wrong character set is used, the byte-to-text conversion may produce incorrect or unreadable characters.
Returns true for success, false for failure.
UncompressStringAsync Deprecated (1)
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.
Note: The application is responsible for deleting (via the C++ delete operator) the object returned by this method.
Returns NULL on failure
WriteFile Deprecated
A convenience method for writing a binary byte array to a file.
Returns true for success, false for failure.
top