Compression Unicode C Reference Documentation

Compression

Current Version: 9.5.0.75

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.

Create/Dispose

HCkCompressionW instance = CkCompressionW_Create();
// ...
CkCompressionW_Dispose(instance);
HCkCompressionW CkCompressionW_Create(void);

Creates an instance of the HCkCompressionW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkCompressionW_Dispose(HCkCompressionW handle);

Objects created by calling CkCompressionW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkCompressionW_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkCompressionW_setAbortCheck(HCkCompressionW cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkCompressionW_setPercentDone(HCkCompressionW cHandle, BOOL (*fnPercentDone)(int pctDone));

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 callback is only called 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 methods 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).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkCompressionW_setProgressInfo(HCkCompressionW cHandle, void (*fnProgressInfo)(const wchar_t *name, const wchar_t *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkCompressionW_setTaskCompleted(HCkCompressionW cHandle, void (*fnTaskCompleted)(HCkTaskW hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

Algorithm
void CkCompressionW_getAlgorithm(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putAlgorithm(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_algorithm(HCkCompressionW cHandle);

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.

top
Charset
void CkCompressionW_getCharset(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putCharset(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_charset(HCkCompressionW cHandle);

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.

top
DebugLogFilePath
void CkCompressionW_getDebugLogFilePath(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putDebugLogFilePath(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_debugLogFilePath(HCkCompressionW cHandle);

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.

top
DeflateLevel
int CkCompressionW_getDeflateLevel(HCkCompressionW cHandle);
void CkCompressionW_putDeflateLevel(HCkCompressionW cHandle, 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 CkCompressionW_getEncodingMode(HCkCompressionW cHandle, HCkString retval);
void CkCompressionW_putEncodingMode(HCkCompressionW cHandle, const wchar_t *newVal);
const wchar_t *CkCompressionW_encodingMode(HCkCompressionW cHandle);

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
HeartbeatMs
int CkCompressionW_getHeartbeatMs(HCkCompressionW cHandle);
void CkCompressionW_putHeartbeatMs(HCkCompressionW cHandle, int newVal);

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

top
LastErrorHtml
void CkCompressionW_getLastErrorHtml(HCkCompressionW cHandle, HCkString retval);
const wchar_t *CkCompressionW_lastErrorHtml(HCkCompressionW cHandle);

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

top
LastErrorText
void CkCompressionW_getLastErrorText(HCkCompressionW cHandle, HCkString retval);
const wchar_t *CkCompressionW_lastErrorText(HCkCompressionW cHandle);

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

top
LastErrorXml
void CkCompressionW_getLastErrorXml(HCkCompressionW cHandle, HCkString retval);
const wchar_t *CkCompressionW_lastErrorXml(HCkCompressionW cHandle);

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

top
LastMethodSuccess
BOOL CkCompressionW_getLastMethodSuccess(HCkCompressionW cHandle);
void CkCompressionW_putLastMethodSuccess(HCkCompressionW cHandle, 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.

top
VerboseLogging
BOOL CkCompressionW_getVerboseLogging(HCkCompressionW cHandle);
void CkCompressionW_putVerboseLogging(HCkCompressionW cHandle, 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 CkCompressionW_getVersion(HCkCompressionW cHandle, HCkString retval);
const wchar_t *CkCompressionW_version(HCkCompressionW cHandle);

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

top

Methods

BeginCompressBytes
BOOL CkCompressionW_BeginCompressBytes(HCkCompressionW cHandle, const unsigned char * data, const unsigned char * outData);

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
BeginCompressBytesAsync (1)
HCkTaskW CkCompressionW_BeginCompressBytesAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
BeginCompressBytesENC
BOOL CkCompressionW_BeginCompressBytesENC(HCkCompressionW cHandle, const unsigned char * data, const wchar_t *outStr);
const wchar_t *CkCompressionW_beginCompressBytesENC(HCkCompressionW cHandle, const unsigned char * 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.

top
BeginCompressBytesENCAsync (1)
HCkTaskW CkCompressionW_BeginCompressBytesENCAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
BeginCompressString
BOOL CkCompressionW_BeginCompressString(HCkCompressionW cHandle, const wchar_t *str, const unsigned char * outData);

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
BeginCompressStringAsync (1)
HCkTaskW CkCompressionW_BeginCompressStringAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
BeginCompressStringENC
BOOL CkCompressionW_BeginCompressStringENC(HCkCompressionW cHandle, const wchar_t *str, const wchar_t *outStr);
const wchar_t *CkCompressionW_beginCompressStringENC(HCkCompressionW cHandle, 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.

More Information and Examples
top
BeginCompressStringENCAsync (1)
HCkTaskW CkCompressionW_BeginCompressStringENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
BeginDecompressBytes
BOOL CkCompressionW_BeginDecompressBytes(HCkCompressionW cHandle, const unsigned char * data, const unsigned char * outData);

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
BeginDecompressBytesAsync (1)
HCkTaskW CkCompressionW_BeginDecompressBytesAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
BeginDecompressBytesENC
BOOL CkCompressionW_BeginDecompressBytesENC(HCkCompressionW cHandle, const wchar_t *str, const unsigned char * outData);

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
BeginDecompressBytesENCAsync (1)
HCkTaskW CkCompressionW_BeginDecompressBytesENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
BeginDecompressString
BOOL CkCompressionW_BeginDecompressString(HCkCompressionW cHandle, const unsigned char * data, const wchar_t *outStr);
const wchar_t *CkCompressionW_beginDecompressString(HCkCompressionW cHandle, const unsigned char * 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.

More Information and Examples
top
BeginDecompressStringAsync (1)
HCkTaskW CkCompressionW_BeginDecompressStringAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
BeginDecompressStringENC
BOOL CkCompressionW_BeginDecompressStringENC(HCkCompressionW cHandle, const wchar_t *str, const wchar_t *outStr);
const wchar_t *CkCompressionW_beginDecompressStringENC(HCkCompressionW cHandle, 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.

top
BeginDecompressStringENCAsync (1)
HCkTaskW CkCompressionW_BeginDecompressStringENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
CompressBd
BOOL CkCompressionW_CompressBd(HCkCompressionW cHandle, HCkBinDataW binData);
Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns TRUE for success, FALSE for failure.

top
CompressBdAsync (1)
HCkTaskW CkCompressionW_CompressBdAsync(HCkCompressionW cHandle, HCkBinDataW 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.)

Returns NULL on failure

top
CompressBytes
BOOL CkCompressionW_CompressBytes(HCkCompressionW cHandle, const unsigned char * data, const unsigned char * outData);

Compresses byte data.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
CompressBytesAsync (1)
HCkTaskW CkCompressionW_CompressBytesAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
CompressBytesENC
BOOL CkCompressionW_CompressBytesENC(HCkCompressionW cHandle, const unsigned char * data, const wchar_t *outStr);
const wchar_t *CkCompressionW_compressBytesENC(HCkCompressionW cHandle, const unsigned char * 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 (1)
HCkTaskW CkCompressionW_CompressBytesENCAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
CompressFile
BOOL CkCompressionW_CompressFile(HCkCompressionW cHandle, 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.

More Information and Examples
top
CompressFileAsync (1)
HCkTaskW CkCompressionW_CompressFileAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
CompressSb
BOOL CkCompressionW_CompressSb(HCkCompressionW cHandle, HCkStringBuilderW sb, HCkBinDataW binData);
Introduced in version 9.5.0.73

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

Returns TRUE for success, FALSE for failure.

top
CompressSbAsync (1)
HCkTaskW CkCompressionW_CompressSbAsync(HCkCompressionW cHandle, HCkStringBuilderW sb, HCkBinDataW binData);
Introduced in version 9.5.0.73

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

Returns NULL on failure

top
CompressStream
BOOL CkCompressionW_CompressStream(HCkCompressionW cHandle, HCkStreamW 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)
HCkTaskW CkCompressionW_CompressStreamAsync(HCkCompressionW cHandle, HCkStreamW 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.)

Returns NULL on failure

top
CompressString
BOOL CkCompressionW_CompressString(HCkCompressionW cHandle, const wchar_t *str, const unsigned char * outData);

Compresses a string.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
CompressStringAsync (1)
HCkTaskW CkCompressionW_CompressStringAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
CompressStringENC
BOOL CkCompressionW_CompressStringENC(HCkCompressionW cHandle, const wchar_t *str, const wchar_t *outStr);
const wchar_t *CkCompressionW_compressStringENC(HCkCompressionW cHandle, 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.

More Information and Examples
top
CompressStringENCAsync (1)
HCkTaskW CkCompressionW_CompressStringENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
DecompressBd
BOOL CkCompressionW_DecompressBd(HCkCompressionW cHandle, HCkBinDataW binData);
Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns TRUE for success, FALSE for failure.

top
DecompressBdAsync (1)
HCkTaskW CkCompressionW_DecompressBdAsync(HCkCompressionW cHandle, HCkBinDataW 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.)

Returns NULL on failure

top
DecompressBytes
BOOL CkCompressionW_DecompressBytes(HCkCompressionW cHandle, const unsigned char * data, const unsigned char * outData);

The opposite of CompressBytes.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
DecompressBytesAsync (1)
HCkTaskW CkCompressionW_DecompressBytesAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
DecompressBytesENC
BOOL CkCompressionW_DecompressBytesENC(HCkCompressionW cHandle, const wchar_t *encodedCompressedData, const unsigned char * 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 (1)
HCkTaskW CkCompressionW_DecompressBytesENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
DecompressFile
BOOL CkCompressionW_DecompressFile(HCkCompressionW cHandle, 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.

More Information and Examples
top
DecompressFileAsync (1)
HCkTaskW CkCompressionW_DecompressFileAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
DecompressSb
BOOL CkCompressionW_DecompressSb(HCkCompressionW cHandle, HCkBinDataW binData, HCkStringBuilderW sb);
Introduced in version 9.5.0.73

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

Returns TRUE for success, FALSE for failure.

top
DecompressSbAsync (1)
HCkTaskW CkCompressionW_DecompressSbAsync(HCkCompressionW cHandle, HCkBinDataW binData, HCkStringBuilderW sb);
Introduced in version 9.5.0.73

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

Returns NULL on failure

top
DecompressStream
BOOL CkCompressionW_DecompressStream(HCkCompressionW cHandle, HCkStreamW 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)
HCkTaskW CkCompressionW_DecompressStreamAsync(HCkCompressionW cHandle, HCkStreamW 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.)

Returns NULL on failure

top
DecompressString
BOOL CkCompressionW_DecompressString(HCkCompressionW cHandle, const unsigned char * data, const wchar_t *outStr);
const wchar_t *CkCompressionW_decompressString(HCkCompressionW cHandle, const unsigned char * data);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
DecompressStringAsync (1)
HCkTaskW CkCompressionW_DecompressStringAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
DecompressStringENC
BOOL CkCompressionW_DecompressStringENC(HCkCompressionW cHandle, const wchar_t *encodedCompressedData, const wchar_t *outStr);
const wchar_t *CkCompressionW_decompressStringENC(HCkCompressionW cHandle, 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.

More Information and Examples
top
DecompressStringENCAsync (1)
HCkTaskW CkCompressionW_DecompressStringENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
EndCompressBytes
BOOL CkCompressionW_EndCompressBytes(HCkCompressionW cHandle, const unsigned char * outData);

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
EndCompressBytesAsync (1)
HCkTaskW CkCompressionW_EndCompressBytesAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
EndCompressBytesENC
BOOL CkCompressionW_EndCompressBytesENC(HCkCompressionW cHandle, const wchar_t *outStr);
const wchar_t *CkCompressionW_endCompressBytesENC(HCkCompressionW cHandle);

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

(See BeginCompressBytesENC)

Returns TRUE for success, FALSE for failure.

top
EndCompressBytesENCAsync (1)
HCkTaskW CkCompressionW_EndCompressBytesENCAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
EndCompressString
BOOL CkCompressionW_EndCompressString(HCkCompressionW cHandle, const unsigned char * outData);

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
EndCompressStringAsync (1)
HCkTaskW CkCompressionW_EndCompressStringAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
EndCompressStringENC
BOOL CkCompressionW_EndCompressStringENC(HCkCompressionW cHandle, const wchar_t *outStr);
const wchar_t *CkCompressionW_endCompressStringENC(HCkCompressionW cHandle);

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
EndCompressStringENCAsync (1)
HCkTaskW CkCompressionW_EndCompressStringENCAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
EndDecompressBytes
BOOL CkCompressionW_EndDecompressBytes(HCkCompressionW cHandle, const unsigned char * outData);

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
EndDecompressBytesAsync (1)
HCkTaskW CkCompressionW_EndDecompressBytesAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
EndDecompressBytesENC
BOOL CkCompressionW_EndDecompressBytesENC(HCkCompressionW cHandle, const unsigned char * outData);

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
EndDecompressBytesENCAsync (1)
HCkTaskW CkCompressionW_EndDecompressBytesENCAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
EndDecompressString
BOOL CkCompressionW_EndDecompressString(HCkCompressionW cHandle, const wchar_t *outStr);
const wchar_t *CkCompressionW_endDecompressString(HCkCompressionW cHandle);

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
EndDecompressStringAsync (1)
HCkTaskW CkCompressionW_EndDecompressStringAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
EndDecompressStringENC
BOOL CkCompressionW_EndDecompressStringENC(HCkCompressionW cHandle, const wchar_t *outStr);
const wchar_t *CkCompressionW_endDecompressStringENC(HCkCompressionW cHandle);

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
EndDecompressStringENCAsync (1)
HCkTaskW CkCompressionW_EndDecompressStringENCAsync(HCkCompressionW cHandle);

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

Returns NULL on failure

top
MoreCompressBytes
BOOL CkCompressionW_MoreCompressBytes(HCkCompressionW cHandle, const unsigned char * data, const unsigned char * outData);

(See BeginCompressBytes)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreCompressBytesAsync (1)
HCkTaskW CkCompressionW_MoreCompressBytesAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
MoreCompressBytesENC
BOOL CkCompressionW_MoreCompressBytesENC(HCkCompressionW cHandle, const unsigned char * data, const wchar_t *outStr);
const wchar_t *CkCompressionW_moreCompressBytesENC(HCkCompressionW cHandle, const unsigned char * data);

(See BeginCompressBytesENC)

Returns TRUE for success, FALSE for failure.

top
MoreCompressBytesENCAsync (1)
HCkTaskW CkCompressionW_MoreCompressBytesENCAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
MoreCompressString
BOOL CkCompressionW_MoreCompressString(HCkCompressionW cHandle, const wchar_t *str, const unsigned char * outData);

(See BeginCompressString)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreCompressStringAsync (1)
HCkTaskW CkCompressionW_MoreCompressStringAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
MoreCompressStringENC
BOOL CkCompressionW_MoreCompressStringENC(HCkCompressionW cHandle, const wchar_t *str, const wchar_t *outStr);
const wchar_t *CkCompressionW_moreCompressStringENC(HCkCompressionW cHandle, const wchar_t *str);

(See BeginCompressStringENC)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreCompressStringENCAsync (1)
HCkTaskW CkCompressionW_MoreCompressStringENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
MoreDecompressBytes
BOOL CkCompressionW_MoreDecompressBytes(HCkCompressionW cHandle, const unsigned char * data, const unsigned char * outData);

(See BeginDecompressBytes)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreDecompressBytesAsync (1)
HCkTaskW CkCompressionW_MoreDecompressBytesAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
MoreDecompressBytesENC
BOOL CkCompressionW_MoreDecompressBytesENC(HCkCompressionW cHandle, const wchar_t *str, const unsigned char * outData);

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
MoreDecompressBytesENCAsync (1)
HCkTaskW CkCompressionW_MoreDecompressBytesENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
MoreDecompressString
BOOL CkCompressionW_MoreDecompressString(HCkCompressionW cHandle, const unsigned char * data, const wchar_t *outStr);
const wchar_t *CkCompressionW_moreDecompressString(HCkCompressionW cHandle, const unsigned char * data);

(See BeginDecompressString)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreDecompressStringAsync (1)
HCkTaskW CkCompressionW_MoreDecompressStringAsync(HCkCompressionW cHandle, const unsigned char * 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.)

Returns NULL on failure

top
MoreDecompressStringENC
BOOL CkCompressionW_MoreDecompressStringENC(HCkCompressionW cHandle, const wchar_t *str, const wchar_t *outStr);
const wchar_t *CkCompressionW_moreDecompressStringENC(HCkCompressionW cHandle, 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.

top
MoreDecompressStringENCAsync (1)
HCkTaskW CkCompressionW_MoreDecompressStringENCAsync(HCkCompressionW cHandle, 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.)

Returns NULL on failure

top
SaveLastError
BOOL CkCompressionW_SaveLastError(HCkCompressionW cHandle, 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.

top
UnlockComponent
BOOL CkCompressionW_UnlockComponent(HCkCompressionW cHandle, 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.

top