CkCompressionW Unicode C++ Reference Documentation

CkCompressionW

Data compression component implementing the PPMD, Bzip2, Deflate, and LZW compression algorithms. .NET, ActiveX, and C++ implementations provide progress monitoring and abort capabilities. Provides a unified API for all supported compression algorithms.

Properties

void get_Algorithm(CkString &str);
const wchar_t *algorithm(void);
void put_Algorithm(const wchar_t *str);

The compression algorithm to be used. Should be set to either "ppmd", "deflate", "zlib", "bzip2", or "lzw".

Note: The PPMD compression algorithm is only available for 32-bit builds. It is not available for 64-bit implementations. Also, this PPMD implementation is the "J" variant.

void get_Charset(CkString &str);
const wchar_t *charset(void);
void put_Charset(const wchar_t *str);

Only applies to methods that compress or decompress strings. This specifies the character encoding that the string should be converted to before compression. Many programming languages use Unicode (2 bytes per char) for representing characters. This property allows for the string to be converted to a 1-byte per char encoding prior to compression.

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

void get_EncodingMode(CkString &str);
const wchar_t *encodingMode(void);
void put_EncodingMode(const wchar_t *str);

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.

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

The number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any method call prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

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

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

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

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

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

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

bool get_LastMethodSuccess(void);
void put_LastMethodSuccess(bool newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

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.

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

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

Methods

bool BeginCompressBytes(const void *data, CkByteData &outData);
const wchar_t *beginCompressBytes(const void *data);

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.

Compress Large Binary File in Blocks

CkTaskW *BeginCompressBytesAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool BeginCompressBytesENC(const void *data, CkString &outStr);
const wchar_t *beginCompressBytesENC(const void *data);

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.

CkTaskW *BeginCompressBytesENCAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool BeginCompressString(const wchar_t *str, CkByteData &outData);
const wchar_t *beginCompressString(const wchar_t *str);

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.

Compress Text Feed to Binary

CkTaskW *BeginCompressStringAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool BeginCompressStringENC(const wchar_t *str, CkString &outStr);
const wchar_t *beginCompressStringENC(const wchar_t *str);

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.

Compress String Feed to Base64

CkTaskW *BeginCompressStringENCAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool BeginDecompressBytes(const void *data, CkByteData &outData);
const wchar_t *beginDecompressBytes(const void *data);

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.

Decompress Large Binary File in Blocks

CkTaskW *BeginDecompressBytesAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool BeginDecompressBytesENC(const wchar_t *str, CkByteData &outData);
const wchar_t *beginDecompressBytesENC(const wchar_t *str);

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.

CkTaskW *BeginDecompressBytesENCAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool BeginDecompressString(const void *data, CkString &outStr);
const wchar_t *beginDecompressString(const void *data);

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.

Decompress Large Text File in Blocks

CkTaskW *BeginDecompressStringAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool BeginDecompressStringENC(const wchar_t *str, CkString &outStr);
const wchar_t *beginDecompressStringENC(const wchar_t *str);

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.

CkTaskW *BeginDecompressStringENCAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool CompressBd(CkBinDataW &binData);

Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns true for success, false for failure.

Compress and Decompress Base64

Compress and Decompress Hex String

CkTaskW *CompressBdAsync(CkBinDataW &binData);

Introduced in version 9.5.0.66

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool CompressBytes(const void *data, CkByteData &outData);
const wchar_t *compressBytes(const void *data);

Compresses byte data.

Returns true for success, false for failure.

Compress Bytes

CkTaskW *CompressBytesAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool CompressBytesENC(const void *data, CkString &outStr);
const wchar_t *compressBytesENC(const void *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.

Compress Bytes to Base64 (or any other encoding)

CkTaskW *CompressBytesENCAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool CompressFile(const wchar_t *srcPath, const wchar_t *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.

Compress and Decompress a File

CkTaskW *CompressFileAsync(const wchar_t *srcPath, const wchar_t *destPath);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool CompressStream(CkStreamW &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.

Streaming Compression

CkTaskW *CompressStreamAsync(CkStreamW &strm);

Introduced in version 9.5.0.56

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool CompressString(const wchar_t *str, CkByteData &outData);
const wchar_t *compressString(const wchar_t *str);

Compresses a string.

Returns true for success, false for failure.

Compress and Decompress a String

CkTaskW *CompressStringAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool CompressStringENC(const wchar_t *str, CkString &outStr);
const wchar_t *compressStringENC(const wchar_t *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.

Returns true for success, false for failure.

Compress and Decompress a String

CkTaskW *CompressStringENCAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool DecompressBd(CkBinDataW &binData);

Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns true for success, false for failure.

Compress and Decompress Base64

Compress and Decompress Hex String

CkTaskW *DecompressBdAsync(CkBinDataW &binData);

Introduced in version 9.5.0.66

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool DecompressBytes(const void *data, CkByteData &outData);
const wchar_t *decompressBytes(const void *data);

The opposite of CompressBytes.

Returns true for success, false for failure.

Decompress Bytes

CkTaskW *DecompressBytesAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool DecompressBytesENC(const wchar_t *encodedCompressedData, CkByteData &outData);
const wchar_t *decompressBytesENC(const wchar_t *encodedCompressedData);

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.

Compress Bytes to Base64 (or any other encoding)

CkTaskW *DecompressBytesENCAsync(const wchar_t *encodedCompressedData);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool DecompressFile(const wchar_t *srcPath, const wchar_t *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.

Compress and Decompress a File

CkTaskW *DecompressFileAsync(const wchar_t *srcPath, const wchar_t *destPath);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool DecompressStream(CkStreamW &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.

Streaming Compression

CkTaskW *DecompressStreamAsync(CkStreamW &strm);

Introduced in version 9.5.0.56

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool DecompressString(const void *data, CkString &outStr);
const wchar_t *decompressString(const void *data);

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

Returns true for success, false for failure.

Compress and Decompress a String

CkTaskW *DecompressStringAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

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

The opposite of CompressStringENC. 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.

Compress and Decompress a String

CkTaskW *DecompressStringENCAsync(const wchar_t *encodedCompressedData);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndCompressBytes(CkByteData &outData);
const wchar_t *endCompressBytes(void);

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

(See BeginCompressBytes)

Returns true for success, false for failure.

Compress Large Binary File in Blocks

CkTaskW *EndCompressBytesAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndCompressBytesENC(CkString &outStr);
const wchar_t *endCompressBytesENC(void);

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

(See BeginCompressBytesENC)

Returns true for success, false for failure.

CkTaskW *EndCompressBytesENCAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndCompressString(CkByteData &outData);
const wchar_t *endCompressString(void);

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

(See BeginCompressString)

Returns true for success, false for failure.

Compress Text Feed to Binary

CkTaskW *EndCompressStringAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndCompressStringENC(CkString &outStr);
const wchar_t *endCompressStringENC(void);

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

(See BeginCompressStringENC)

Returns true for success, false for failure.

Compress String Feed to Base64

CkTaskW *EndCompressStringENCAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndDecompressBytes(CkByteData &outData);
const wchar_t *endDecompressBytes(void);

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

(See BeginDecompressBytes)

Returns true for success, false for failure.

Decompress Large Binary File in Blocks

CkTaskW *EndDecompressBytesAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndDecompressBytesENC(CkByteData &outData);
const wchar_t *endDecompressBytesENC(void);

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.

CkTaskW *EndDecompressBytesENCAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndDecompressString(CkString &outStr);
const wchar_t *endDecompressString(void);

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

(See BeginDecompressString)

Returns true for success, false for failure.

Decompress Large Text File in Blocks

CkTaskW *EndDecompressStringAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool EndDecompressStringENC(CkString &outStr);
const wchar_t *endDecompressStringENC(void);

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.

CkTaskW *EndDecompressStringENCAsync(void);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreCompressBytes(const void *data, CkByteData &outData);
const wchar_t *moreCompressBytes(const void *data);

(See BeginCompressBytes)

Returns true for success, false for failure.

Compress Large Binary File in Blocks

CkTaskW *MoreCompressBytesAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreCompressBytesENC(const void *data, CkString &outStr);
const wchar_t *moreCompressBytesENC(const void *data);

(See BeginCompressBytesENC)

Returns true for success, false for failure.

CkTaskW *MoreCompressBytesENCAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreCompressString(const wchar_t *str, CkByteData &outData);
const wchar_t *moreCompressString(const wchar_t *str);

(See BeginCompressString)

Returns true for success, false for failure.

Compress Text Feed to Binary

CkTaskW *MoreCompressStringAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreCompressStringENC(const wchar_t *str, CkString &outStr);
const wchar_t *moreCompressStringENC(const wchar_t *str);

(See BeginCompressStringENC)

Returns true for success, false for failure.

Compress String Feed to Base64

CkTaskW *MoreCompressStringENCAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreDecompressBytes(const void *data, CkByteData &outData);
const wchar_t *moreDecompressBytes(const void *data);

(See BeginDecompressBytes)

Returns true for success, false for failure.

Decompress Large Binary File in Blocks

CkTaskW *MoreDecompressBytesAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreDecompressBytesENC(const wchar_t *str, CkByteData &outData);
const wchar_t *moreDecompressBytesENC(const wchar_t *str);

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.

CkTaskW *MoreDecompressBytesENCAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreDecompressString(const void *data, CkString &outStr);
const wchar_t *moreDecompressString(const void *data);

(See BeginDecompressString)

Returns true for success, false for failure.

Decompress Large Text File in Blocks

CkTaskW *MoreDecompressStringAsync(const void *data);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool MoreDecompressStringENC(const wchar_t *str, CkString &outStr);
const wchar_t *moreDecompressStringENC(const wchar_t *str);

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.

CkTaskW *MoreDecompressStringENCAsync(const wchar_t *str);

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

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

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

Returns NULL on failure

How to Run an Asynchronous Task

bool SaveLastError(const wchar_t *path);

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

Returns true for success, false for failure.

bool UnlockComponent(const wchar_t *unlockCode);

Unlocks the component allowing for the full functionality to be used. The component may be used fully-functional for the 1st 30-days after download by passing an arbitrary string to this method. If for some reason you do not receive the full 30-day trial, send email to support@chilkatsoft.com for a temporary unlock code w/ an explicit expiration date. Upon purchase, a purchased unlock code is provided which should replace the temporary/arbitrary string passed to this method.

Returns true for success, false for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

Events

void AbortCheck(bool *abort);

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

void BinaryData(const unsigned char *data, unsigned int length);

Binary data provided by certain methods.

void PercentDone(int pctDone, bool *abort);

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

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

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void TaskCompleted(CkTaskW &task);

Called in the background thread when an asynchronous task completes.

void TextData(const wchar_t *data);

Text data provided by certain methods.