Compression C++ Reference Documentation

CkCompression

Current Version: 11.1.0

Implements the Bzip2, Deflate, and LZW compression algorithms.

Object Creation

// Local variable on the stack
CkCompression obj;

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

Properties

Algorithm
void get_Algorithm(CkString &str);
const char *algorithm(void);
void put_Algorithm(const char *ansiOrUtf8Str);

Specifies the compression algorithm: deflate, zlib, bzip2, or lzw. Note that ppmd is deprecated and should not be used. It was only available for 32-bit systems and specifically used the J variant. Please transition to one of the recommended algorithms.

top
Charset
void get_Charset(CkString &str);
const char *charset(void);
void put_Charset(const char *ansiOrUtf8Str);

This property specifies the character encoding used to represent text as bytes for compression and decompression. By default, it uses the computer's ANSI charset, such as Windows-1252 for locales like the United States, United Kingdom, Western Europe, Australia, and New Zealand.

Most applications are advised to set this property to UTF-8. Chilkat plans to change its default to UTF-8 in a future major version to align with current standards. The current default of ANSI stems from a time when UTF-8 was not widely adopted.

top
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
top
DeflateLevel
int get_DeflateLevel(void);
void put_DeflateLevel(int newVal);
Introduced in version 9.5.0.73

This property allows for customization of the compression level for the deflate and zlib compression algoirthms. (zlib is just the deflate algorithm with a zlib header.) A value of 0 = no compression, while 9 = maximum compression. The default is 6.

top
EncodingMode
void get_EncodingMode(CkString &str);
const char *encodingMode(void);
void put_EncodingMode(const char *ansiOrUtf8Str);

Controls the encoding expected by methods ending in ENC, such as CompressBytesENC. Valid values are base64, hex, url, and quoted-printable. Compression methods ending in ENC return the binary compressed data as an encoded string using this encoding. Decompress methods expect the input string to be this encoding.

top
FirstChunk
bool get_FirstChunk(void);
void put_FirstChunk(bool newVal);
Introduced in version 11.0.0

This property applies to FirstChunk and LastChunk aware compression and decompression methods. It signifies that the data being compressed is the first of multiple chunks.

The default value is true.

When both FirstChunk and LastChunk are set to true, it means the entire amount of data to be compressed or decompressed is presented in a single call.

top
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
top
LastChunk
bool get_LastChunk(void);
void put_LastChunk(bool newVal);
Introduced in version 11.0.0

This property applies to FirstChunk and LastChunk aware compression and decompression methods. It signifies that the data being compressed is the last of multiple chunks.

The default value is true.

When both FirstChunk and LastChunk are set to true, it means the entire amount of data to be compressed or decompressed is presented in a single call.

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

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

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

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

top
UncommonOptions
void get_UncommonOptions(CkString &str);
const char *uncommonOptions(void);
void put_UncommonOptions(const char *ansiOrUtf8Str);
Introduced in version 11.0.0

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

Can be set to a list of the following comma separated keywords:

  • Crypt2CompressHdr - Duplicates the compression and decompression as implemented in the deprecated and removed Crypt2 compression functions.

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

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 "10.1.0"

More Information and Examples
top

Methods

CompressBd
bool CompressBd(CkBinData &bd);
Introduced in version 9.5.0.66

Compresses the data contained in bd. This method is not FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
CompressBdAsync (1)
CkTask *CompressBdAsync(CkBinData &bd);
Introduced in version 9.5.0.66

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

top
CompressBd2
bool CompressBd2(CkBinData &bdIn, CkBinData &bdOut);
Introduced in version 11.0.0

This method compresses the data in bdIn without modifying it and appends the compressed data to bdOut. It is also FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
CompressBd2Async (1)
CkTask *CompressBd2Async(CkBinData &bdIn, CkBinData &bdOut);
Introduced in version 11.0.0

Creates an asynchronous task to call the CompressBd2 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

top
CompressEncryptFile
bool CompressEncryptFile(CkJsonObject &cryptParams, const char *srcPath, const char *destPath);
Introduced in version 9.5.0.99

Performs file-to-file compression and encryption. Files of any size may be compressed because the file is compressed and encrypted internally in streaming mode.

Returns true for success, false for failure.

top
CompressEncryptFileAsync (1)
CkTask *CompressEncryptFileAsync(CkJsonObject &cryptParams, const char *srcPath, const char *destPath);
Introduced in version 9.5.0.99

Creates an asynchronous task to call the CompressEncryptFile 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

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

Performs file-to-file compression. Files of any size may be compressed because the file is compressed internally in streaming mode.

Returns true for success, false for failure.

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

top
CompressSb
bool CompressSb(CkStringBuilder &sb, CkBinData &binData);
Introduced in version 9.5.0.73

Compresses the contents of sb and appends the compressed bytes to binData.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
CompressSbAsync (1)
CkTask *CompressSbAsync(CkStringBuilder &sb, CkBinData &binData);
Introduced in version 9.5.0.73

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

top
CompressStream
bool CompressStream(CkStream &strm);
Introduced in version 9.5.0.56

Compresses a stream. Internally, the strm's source is read, compressed, and the compressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be compressed with stable ungrowing memory usage.

Returns true for success, false for failure.

More Information and Examples
top
CompressStreamAsync (1)
CkTask *CompressStreamAsync(CkStream &strm);
Introduced in version 9.5.0.56

Creates an asynchronous task to call the CompressStream 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

top
CompressStringENC
bool CompressStringENC(const char *str, CkString &outStr);
const char *compressStringENC(const char *str);

Compresses a string and returns the compressed data encoded to a string. The output encoding (hex, base64, etc.) is determined by the EncodingMode property setting. This method is NOT FirstChunk/LastChunk aware.

Returns true for success, false for failure.

More Information and Examples
top
CompressStringENCAsync (1)
CkTask *CompressStringENCAsync(const char *str);

Creates an asynchronous task to call the CompressStringENC 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

top
DecompressBd
bool DecompressBd(CkBinData &bd);
Introduced in version 9.5.0.66

Decompresses the data contained in bd. This method is NOT FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
DecompressBdAsync (1)
CkTask *DecompressBdAsync(CkBinData &bd);
Introduced in version 9.5.0.66

Creates an asynchronous task to call the DecompressBd 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

top
DecompressBd2
bool DecompressBd2(CkBinData &bdIn, CkBinData &bdOut);
Introduced in version 11.0.0

This method decompresses the data in bdIn without modifying it and appends the decompressed data to bdOut. It is also FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
DecompressBd2Async (1)
CkTask *DecompressBd2Async(CkBinData &bdIn, CkBinData &bdOut);
Introduced in version 11.0.0

Creates an asynchronous task to call the DecompressBd2 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

top
DecompressFile
bool DecompressFile(const char *srcPath, const char *destPath);

Performs file-to-file decompression (the opposite of CompressFile). Internally the file is decompressed in streaming mode which allows files of any size to be decompressed.

Returns true for success, false for failure.

More Information and Examples
top
DecompressFileAsync (1)
CkTask *DecompressFileAsync(const char *srcPath, const char *destPath);

Creates an asynchronous task to call the DecompressFile 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

top
DecompressSb
bool DecompressSb(CkBinData &binData, CkStringBuilder &sb);
Introduced in version 9.5.0.73

Decompresses the contents of binData and appends the decompressed string to sb.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
DecompressSbAsync (1)
CkTask *DecompressSbAsync(CkBinData &binData, CkStringBuilder &sb);
Introduced in version 9.5.0.73

Creates an asynchronous task to call the DecompressSb 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

top
DecompressStream
bool DecompressStream(CkStream &strm);
Introduced in version 9.5.0.56

Decompresses a stream. Internally, the strm's source is read, decompressed, and the decompressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be decompressed with stable ungrowing memory usage.

Returns true for success, false for failure.

More Information and Examples
top
DecompressStreamAsync (1)
CkTask *DecompressStreamAsync(CkStream &strm);
Introduced in version 9.5.0.56

Creates an asynchronous task to call the DecompressStream 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

top
DecompressStringENC
bool DecompressStringENC(const char *encodedCompressedData, CkString &outStr);
const char *decompressStringENC(const char *encodedCompressedData);

The opposite of CompressStringENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting. This method is NOT FirstChunk/LastChunk aware.

Returns true for success, false for failure.

More Information and Examples
top
DecompressStringENCAsync (1)
CkTask *DecompressStringENCAsync(const char *encodedCompressedData);

Creates an asynchronous task to call the DecompressStringENC 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

top
DecryptDecompressFile
bool DecryptDecompressFile(CkJsonObject &cryptParams, const char *srcPath, const char *destPath);
Introduced in version 9.5.0.99

Performs file-to-file decryption and decompression.

Returns true for success, false for failure.

top
DecryptDecompressFileAsync (1)
CkTask *DecryptDecompressFileAsync(CkJsonObject &cryptParams, const char *srcPath, const char *destPath);
Introduced in version 9.5.0.99

Creates an asynchronous task to call the DecryptDecompressFile 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

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

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:

  CkCompression compression;

  MyCompressionProgress callbackObj;

  compression.put_EventCallbackObject(&callbackObj);

MyCompressionProgress example:

#include "CkBaseProgress.h"

class MyCompressionProgress : public CkBaseProgress {

  public:
    MyCompressionProgress();
    virtual ~MyCompressionProgress();

    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
top
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
top
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
top
TaskCompleted
void TaskCompleted(CkTask &task);

Called from the background thread when an asynchronous task completes.

top

Deprecated

BeginCompressBytes
bool BeginCompressBytes(CkByteData &data, CkByteData &outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2 .

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

More Information and Examples
top
BeginCompressBytes2
bool BeginCompressBytes2(const void *pByteData, unsigned long szByteData, CkByteData &outBytes);
Introduced in version 9.5.0.82
This method is deprecated. It will be removed in a future version.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginCompressBytesENC
bool BeginCompressBytesENC(CkByteData &data, CkString &outStr);
const char *beginCompressBytesENC(CkByteData &data);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytesENC, followed by 0 or more calls to MoreCompressedBytesENC, and ending with a final call to EndCompressBytesENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginCompressString
bool BeginCompressString(const char *str, CkByteData &outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Large amounts of string data may be compressed in chunks by first calling BeginCompressString, followed by 0 or more calls to MoreCompressedString, and ending with a final call to EndCompressString. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

More Information and Examples
top
BeginCompressStringENC
bool BeginCompressStringENC(const char *str, CkString &outStr);
const char *beginCompressStringENC(const char *str);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Large amounts of string data may be compressed in chunks by first calling BeginCompressStringENC, followed by 0 or more calls to MoreCompressedStringENC, and ending with a final call to EndCompressStringENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginDecompressBytes
bool BeginDecompressBytes(CkByteData &data, CkByteData &outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.

Returns true for success, false for failure.

More Information and Examples
top
BeginDecompressBytes2
bool BeginDecompressBytes2(const void *pByteData, unsigned long szByteData, CkByteData &outBytes);
Introduced in version 9.5.0.82
This method is deprecated. It will be removed in a future version.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.

Returns true for success, false for failure.

top
BeginDecompressBytesENC
bool BeginDecompressBytesENC(const char *str, CkByteData &outData);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytesENC, followed by 0 or more calls to MoreDecompressedBytesENC, and ending with a final call to EndDecompressBytesENC. Each call returns 0 or more bytes of decompressed data.

Returns true for success, false for failure.

top
BeginDecompressString
bool BeginDecompressString(CkByteData &data, CkString &outStr);
const char *beginDecompressString(CkByteData &data);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressString, followed by 0 or more calls to MoreDecompressedString, and ending with a final call to EndDecompressString. Each call returns 0 or more characters of decompressed text.

Returns true for success, false for failure.

More Information and Examples
top
BeginDecompressStringENC
bool BeginDecompressStringENC(const char *str, CkString &outStr);
const char *beginDecompressStringENC(const char *str);
This method is deprecated and replaced by FirstChunk

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressStringENC, followed by 0 or more calls to MoreDecompressedStringENC, and ending with a final call to EndDecompressStringENC. Each call returns 0 or more characters of decompressed text.

Returns true for success, false for failure.

top
CompressBytes Deprecated
bool CompressBytes(CkByteData &data, CkByteData &outData);

Compresses byte data.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
CompressBytesAsync Deprecated (1)
CkTask *CompressBytesAsync(CkByteData &data);

Creates an asynchronous task to call the CompressBytes 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

top
CompressBytes2 Deprecated
bool CompressBytes2(const void *pByteData, unsigned long szByteData, CkByteData &outBytes);
Introduced in version 9.5.0.82

Compresses byte data.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
CompressBytesENC Deprecated
bool CompressBytesENC(CkByteData &data, CkString &outStr);
const char *compressBytesENC(CkByteData &data);

Compresses bytes and returns the compressed data encoded to a string. The encoding (hex, base64, etc.) is determined by the EncodingMode property setting.

Returns true for success, false for failure.

top
CompressBytesENCAsync Deprecated (1)
CkTask *CompressBytesENCAsync(CkByteData &data);

Creates an asynchronous task to call the CompressBytesENC 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

top
CompressStr Deprecated
bool CompressStr(const char *str, CkBinData &bd);
Introduced in version 11.0.0

Compresses a string and appends to bd. The byte representation (character encoding) of the actual bytes to be compressed is determined by the Charset property. This method is FirstChunk / LastChunk aware.

Returns true for success, false for failure.

top
CompressStrAsync Deprecated (1)
CkTask *CompressStrAsync(const char *str, CkBinData &bd);
Introduced in version 11.0.0

Creates an asynchronous task to call the CompressStr 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

top
CompressString Deprecated
bool CompressString(const char *str, CkByteData &outData);

Compresses a string.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
CompressStringAsync Deprecated (1)
CkTask *CompressStringAsync(const char *str);

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

top
DecompressBytes Deprecated
bool DecompressBytes(CkByteData &data, CkByteData &outData);

This method decompresses bytes.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
DecompressBytesAsync Deprecated (1)
CkTask *DecompressBytesAsync(CkByteData &data);

Creates an asynchronous task to call the DecompressBytes 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

top
DecompressBytes2 Deprecated
bool DecompressBytes2(const void *pByteData, unsigned long szByteData, CkByteData &outBytes);
Introduced in version 9.5.0.82

This method decompresses bytes.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
DecompressBytesENC Deprecated
bool DecompressBytesENC(const char *encodedCompressedData, CkByteData &outData);

The opposite of CompressBytesENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting.

Returns true for success, false for failure.

top
DecompressBytesENCAsync Deprecated (1)
CkTask *DecompressBytesENCAsync(const char *encodedCompressedData);

Creates an asynchronous task to call the DecompressBytesENC 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

top
DecompressString Deprecated
bool DecompressString(CkByteData &data, CkString &outStr);
const char *decompressString(CkByteData &data);

Takes compressed bytes, decompresses, and returns the resulting string.

This method is FirstChunk/LastChunk aware.

Returns true for success, false for failure.

top
EndCompressBytes
bool EndCompressBytes(CkByteData &outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
EndCompressBytesENC
bool EndCompressBytesENC(CkString &outStr);
const char *endCompressBytesENC(void);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytesENC)

Returns true for success, false for failure.

top
EndCompressString
bool EndCompressString(CkByteData &outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressString)

Returns true for success, false for failure.

More Information and Examples
top
EndCompressStringENC
bool EndCompressStringENC(CkString &outStr);
const char *endCompressStringENC(void);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressStringENC)

Returns true for success, false for failure.

More Information and Examples
top
EndDecompressBytes
bool EndDecompressBytes(CkByteData &outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
EndDecompressBytesENC
bool EndDecompressBytesENC(CkByteData &outData);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns true for success, false for failure.

top
EndDecompressString
bool EndDecompressString(CkString &outStr);
const char *endDecompressString(void);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressString)

Returns true for success, false for failure.

More Information and Examples
top
EndDecompressStringENC
bool EndDecompressStringENC(CkString &outStr);
const char *endDecompressStringENC(void);
This method is deprecated.

The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns true for success, false for failure.

top
MoreCompressBytes
bool MoreCompressBytes(CkByteData &data, CkByteData &outData);
This method is deprecated.

(See BeginCompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
MoreCompressBytes2
bool MoreCompressBytes2(const void *pByteData, unsigned long szByteData, CkByteData &outBytes);
Introduced in version 9.5.0.82
This method is deprecated. It will be removed in a future version.

(See BeginCompressBytes2)

Returns true for success, false for failure.

top
MoreCompressBytesENC
bool MoreCompressBytesENC(CkByteData &data, CkString &outStr);
const char *moreCompressBytesENC(CkByteData &data);
This method is deprecated.

(See BeginCompressBytesENC)

Returns true for success, false for failure.

top
MoreCompressString
bool MoreCompressString(const char *str, CkByteData &outData);
This method is deprecated.

(See BeginCompressString)

Returns true for success, false for failure.

More Information and Examples
top
MoreCompressStringENC
bool MoreCompressStringENC(const char *str, CkString &outStr);
const char *moreCompressStringENC(const char *str);
This method is deprecated.

(See BeginCompressStringENC)

Returns true for success, false for failure.

More Information and Examples
top
MoreDecompressBytes
bool MoreDecompressBytes(CkByteData &data, CkByteData &outData);
This method is deprecated.

(See BeginDecompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
MoreDecompressBytes2
bool MoreDecompressBytes2(const void *pByteData, unsigned long szByteData, CkByteData &outBytes);
Introduced in version 9.5.0.82
This method is deprecated. It will be removed in a future version.

(See BeginDecompressBytes2)

Returns true for success, false for failure.

top
MoreDecompressBytesENC
bool MoreDecompressBytesENC(const char *str, CkByteData &outData);
This method is deprecated.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns true for success, false for failure.

top
MoreDecompressString
bool MoreDecompressString(CkByteData &data, CkString &outStr);
const char *moreDecompressString(CkByteData &data);
This method is deprecated.

(See BeginDecompressString)

Returns true for success, false for failure.

More Information and Examples
top
MoreDecompressStringENC
bool MoreDecompressStringENC(const char *str, CkString &outStr);
const char *moreDecompressStringENC(const char *str);
This method is deprecated.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns true for success, false for failure.

top