Gzip C++ Reference Documentation

CkGzip

Current Version: 11.1.0

Requires Chilkat Bundle License

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

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.

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.

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
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.

More Information and Examples

Example showing how to use DebugLogFilePath.

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.

HeartbeatMs

int get_HeartbeatMs(void);
void put_HeartbeatMs(int newVal);

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.

More Information and Examples

Event Callback Examples

LastErrorHtml

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

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.

LastErrorText

void get_LastErrorText(CkString &str);
const char *lastErrorText(void);

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void get_LastErrorXml(CkString &str);
const char *lastErrorXml(void);

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.

LastMethodSuccess

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

LastModStr

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

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.

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.

Utf8

bool get_Utf8(void);
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

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.

Version

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

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

More Information and Examples

How to get the Chilkat version at runtime.

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

Gzip Compress In Memory and Base64 Encode

CompressBdAsync ⁽¹⁾

CkTask *CompressBdAsync(CkBinData &binDat);

Introduced in version 9.5.0.67

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

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

CompressFileAsync ⁽¹⁾

CkTask *CompressFileAsync(const char *inFilename, const char *destPath);

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

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

CompressFile2Async ⁽¹⁾

CkTask *CompressFile2Async(const char *inFilename, const char *embeddedFilename, const char *destPath);

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

bool CompressFileBd(const char *filePath, CkBinData &bd);

Introduced in version 11.0.0

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.

CompressFileBdAsync ⁽¹⁾

CkTask *CompressFileBdAsync(const char *filePath, CkBinData &bd);

Introduced in version 11.0.0

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

bool CompressSb(CkStringBuilder &sb, const char *charset, CkBinData &bd);

Introduced in version 11.0.0

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.

CompressSbAsync ⁽¹⁾

CkTask *CompressSbAsync(CkStringBuilder &sb, const char *charset, CkBinData &bd);

Introduced in version 11.0.0

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

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.

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

Full List of Charset Names

CompressStringToFileAsync ⁽¹⁾

CkTask *CompressStringToFileAsync(const char *inStr, const char *destCharset, const char *destPath);

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

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

Full List of Charset Names

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.

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.

IsGzip

bool IsGzip(CkBinData &bd);

Introduced in version 11.0.0

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

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.

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.

SetExtraData

bool SetExtraData(const char *encodedData, const char *encoding);

Introduced in version 11.0.0

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.

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.

UncompressBdAsync ⁽¹⁾

CkTask *UncompressBdAsync(CkBinData &binDat);

Introduced in version 9.5.0.67

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

bool UncompressBdToFile(CkBinData &bd, const char *filePath);

Introduced in version 11.0.0

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

Returns true for success, false for failure.

UncompressBdToFileAsync ⁽¹⁾

CkTask *UncompressBdToFileAsync(CkBinData &bd, const char *filePath);

Introduced in version 11.0.0

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

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

GZip Decompress File

UncompressFileAsync ⁽¹⁾

CkTask *UncompressFileAsync(const char *srcPath, const char *destPath);

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

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

List of Valid Charsets

UncompressFileToStringAsync ⁽¹⁾

CkTask *UncompressFileToStringAsync(const char *gzFilename, const char *charset);

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

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.

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.

UnTarGzAsync ⁽¹⁾

CkTask *UnTarGzAsync(const char *tgzFilename, const char *destDir, bool bNoAbsolute);

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

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.

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

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.

More Information and Examples

Chilkat Event Callback Examples

PercentDone

void PercentDone(int pctDone, bool *abort);

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.

More Information and Examples

Chilkat Event Callback Examples

ProgressInfo

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

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.

More Information and Examples

Chilkat Event Callback Examples

TaskCompleted

void TaskCompleted(CkTask &task);

Called from the background thread when an asynchronous task completes.

Deprecated

CompressFileToMem Deprecated

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

Gzip compresses a file into an in-memory .gz image with a maximum size limit of 4GB.

Returns true for success, false for failure.

CompressFileToMemAsync Deprecated ⁽¹⁾

CkTask *CompressFileToMemAsync(const char *inFilename);

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

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.

CompressMemoryAsync Deprecated ⁽¹⁾

CkTask *CompressMemoryAsync(CkByteData &inData);

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

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.

CompressMemToFileAsync Deprecated ⁽¹⁾

CkTask *CompressMemToFileAsync(CkByteData &inData, const char *destPath);

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

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

Full List of Charset Names

CompressStringAsync Deprecated ⁽¹⁾

CkTask *CompressStringAsync(const char *inStr, const char *destCharset);

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

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.

Encode Deprecated

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.

ExamineMemory Deprecated

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.

GetDt

CkDateTime *GetDt(void);

This method is deprecated.

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

ReadFile Deprecated

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.

UncompressFileToMem Deprecated

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.

UncompressFileToMemAsync Deprecated ⁽¹⁾

CkTask *UncompressFileToMemAsync(const char *inFilename);

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

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.

UncompressMemoryAsync Deprecated ⁽¹⁾

CkTask *UncompressMemoryAsync(CkByteData &inData);

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

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.

UncompressMemToFileAsync Deprecated ⁽¹⁾

CkTask *UncompressMemToFileAsync(CkByteData &inData, const char *destPath);

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

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

Full List of Charset Names

UncompressStringAsync Deprecated ⁽¹⁾

CkTask *UncompressStringAsync(CkByteData &inData, const char *inCharset);

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

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.