Compression C Reference Documentation

Compression

Current Version: 9.5.0.73

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

HCkCompression instance = CkCompression_Create();
// ...
CkCompression_Dispose(instance);
HCkCompression CkCompression_Create(void);

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

void CkCompression_Dispose(HCkCompression handle);

Objects created by calling CkCompression_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 CkCompression_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkCompression_setAbortCheck(HCkCompression 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 CkCompression_setPercentDone(HCkCompression 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 CkCompression_setProgressInfo(HCkCompression cHandle, void (*fnProgressInfo)(const char *name, const char *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 CkCompression_setTaskCompleted(HCkCompression cHandle, void (*fnTaskCompleted)(HCkTask 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 CkCompression_getAlgorithm(HCkCompression cHandle, HCkString retval);
void CkCompression_putAlgorithm(HCkCompression cHandle, const char *newVal);
const char *CkCompression_algorithm(HCkCompression 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 CkCompression_getCharset(HCkCompression cHandle, HCkString retval);
void CkCompression_putCharset(HCkCompression cHandle, const char *newVal);
const char *CkCompression_charset(HCkCompression 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 CkCompression_getDebugLogFilePath(HCkCompression cHandle, HCkString retval);
void CkCompression_putDebugLogFilePath(HCkCompression cHandle, const char *newVal);
const char *CkCompression_debugLogFilePath(HCkCompression 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 CkCompression_getDeflateLevel(HCkCompression cHandle);
void CkCompression_putDeflateLevel(HCkCompression 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 CkCompression_getEncodingMode(HCkCompression cHandle, HCkString retval);
void CkCompression_putEncodingMode(HCkCompression cHandle, const char *newVal);
const char *CkCompression_encodingMode(HCkCompression 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 CkCompression_getHeartbeatMs(HCkCompression cHandle);
void CkCompression_putHeartbeatMs(HCkCompression 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 CkCompression_getLastErrorHtml(HCkCompression cHandle, HCkString retval);
const char *CkCompression_lastErrorHtml(HCkCompression 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 CkCompression_getLastErrorText(HCkCompression cHandle, HCkString retval);
const char *CkCompression_lastErrorText(HCkCompression 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 CkCompression_getLastErrorXml(HCkCompression cHandle, HCkString retval);
const char *CkCompression_lastErrorXml(HCkCompression 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 CkCompression_getLastMethodSuccess(HCkCompression cHandle);
void CkCompression_putLastMethodSuccess(HCkCompression 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
Utf8
BOOL CkCompression_getUtf8(HCkCompression cHandle);
void CkCompression_putUtf8(HCkCompression cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkCompression_getVerboseLogging(HCkCompression cHandle);
void CkCompression_putVerboseLogging(HCkCompression 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 CkCompression_getVersion(HCkCompression cHandle, HCkString retval);
const char *CkCompression_version(HCkCompression cHandle);

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

top

Methods

BeginCompressBytes
BOOL CkCompression_BeginCompressBytes(HCkCompression cHandle, HCkByteData data, HCkByteData 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)
HCkTask CkCompression_BeginCompressBytesAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_BeginCompressBytesENC(HCkCompression cHandle, HCkByteData data, HCkString outStr);
const char *CkCompression_beginCompressBytesENC(HCkCompression cHandle, HCkByteData 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)
HCkTask CkCompression_BeginCompressBytesENCAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_BeginCompressString(HCkCompression cHandle, const char *str, HCkByteData 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)
HCkTask CkCompression_BeginCompressStringAsync(HCkCompression cHandle, const char *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 CkCompression_BeginCompressStringENC(HCkCompression cHandle, const char *str, HCkString outStr);
const char *CkCompression_beginCompressStringENC(HCkCompression cHandle, const char *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)
HCkTask CkCompression_BeginCompressStringENCAsync(HCkCompression cHandle, const char *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 CkCompression_BeginDecompressBytes(HCkCompression cHandle, HCkByteData data, HCkByteData 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)
HCkTask CkCompression_BeginDecompressBytesAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_BeginDecompressBytesENC(HCkCompression cHandle, const char *str, HCkByteData 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)
HCkTask CkCompression_BeginDecompressBytesENCAsync(HCkCompression cHandle, const char *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 CkCompression_BeginDecompressString(HCkCompression cHandle, HCkByteData data, HCkString outStr);
const char *CkCompression_beginDecompressString(HCkCompression cHandle, HCkByteData 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)
HCkTask CkCompression_BeginDecompressStringAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_BeginDecompressStringENC(HCkCompression cHandle, const char *str, HCkString outStr);
const char *CkCompression_beginDecompressStringENC(HCkCompression cHandle, const char *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)
HCkTask CkCompression_BeginDecompressStringENCAsync(HCkCompression cHandle, const char *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 CkCompression_CompressBd(HCkCompression cHandle, HCkBinData 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)
HCkTask CkCompression_CompressBdAsync(HCkCompression cHandle, HCkBinData 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 CkCompression_CompressBytes(HCkCompression cHandle, HCkByteData data, HCkByteData outData);

Compresses byte data.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
CompressBytesAsync (1)
HCkTask CkCompression_CompressBytesAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_CompressBytesENC(HCkCompression cHandle, HCkByteData data, HCkString outStr);
const char *CkCompression_compressBytesENC(HCkCompression cHandle, HCkByteData 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)
HCkTask CkCompression_CompressBytesENCAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_CompressFile(HCkCompression cHandle, 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)
HCkTask CkCompression_CompressFileAsync(HCkCompression cHandle, const char *srcPath, const char *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 CkCompression_CompressSb(HCkCompression cHandle, HCkStringBuilder sb, HCkBinData 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)
HCkTask CkCompression_CompressSbAsync(HCkCompression cHandle, HCkStringBuilder sb, HCkBinData 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 CkCompression_CompressStream(HCkCompression cHandle, HCkStream 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)
HCkTask CkCompression_CompressStreamAsync(HCkCompression cHandle, HCkStream 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 CkCompression_CompressString(HCkCompression cHandle, const char *str, HCkByteData outData);

Compresses a string.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
CompressStringAsync (1)
HCkTask CkCompression_CompressStringAsync(HCkCompression cHandle, const char *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 CkCompression_CompressStringENC(HCkCompression cHandle, const char *str, HCkString outStr);
const char *CkCompression_compressStringENC(HCkCompression cHandle, 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.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
CompressStringENCAsync (1)
HCkTask CkCompression_CompressStringENCAsync(HCkCompression cHandle, const char *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 CkCompression_DecompressBd(HCkCompression cHandle, HCkBinData 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)
HCkTask CkCompression_DecompressBdAsync(HCkCompression cHandle, HCkBinData 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 CkCompression_DecompressBytes(HCkCompression cHandle, HCkByteData data, HCkByteData outData);

The opposite of CompressBytes.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
DecompressBytesAsync (1)
HCkTask CkCompression_DecompressBytesAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_DecompressBytesENC(HCkCompression cHandle, const char *encodedCompressedData, HCkByteData 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)
HCkTask CkCompression_DecompressBytesENCAsync(HCkCompression cHandle, const char *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 CkCompression_DecompressFile(HCkCompression cHandle, 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)
HCkTask CkCompression_DecompressFileAsync(HCkCompression cHandle, const char *srcPath, const char *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 CkCompression_DecompressSb(HCkCompression cHandle, HCkBinData binData, HCkStringBuilder 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)
HCkTask CkCompression_DecompressSbAsync(HCkCompression cHandle, HCkBinData binData, HCkStringBuilder 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 CkCompression_DecompressStream(HCkCompression cHandle, HCkStream 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)
HCkTask CkCompression_DecompressStreamAsync(HCkCompression cHandle, HCkStream 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 CkCompression_DecompressString(HCkCompression cHandle, HCkByteData data, HCkString outStr);
const char *CkCompression_decompressString(HCkCompression cHandle, HCkByteData data);

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

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
DecompressStringAsync (1)
HCkTask CkCompression_DecompressStringAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_DecompressStringENC(HCkCompression cHandle, const char *encodedCompressedData, HCkString outStr);
const char *CkCompression_decompressStringENC(HCkCompression cHandle, 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.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
DecompressStringENCAsync (1)
HCkTask CkCompression_DecompressStringENCAsync(HCkCompression cHandle, const char *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 CkCompression_EndCompressBytes(HCkCompression cHandle, HCkByteData 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)
HCkTask CkCompression_EndCompressBytesAsync(HCkCompression 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 CkCompression_EndCompressBytesENC(HCkCompression cHandle, HCkString outStr);
const char *CkCompression_endCompressBytesENC(HCkCompression 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)
HCkTask CkCompression_EndCompressBytesENCAsync(HCkCompression 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 CkCompression_EndCompressString(HCkCompression cHandle, HCkByteData 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)
HCkTask CkCompression_EndCompressStringAsync(HCkCompression 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 CkCompression_EndCompressStringENC(HCkCompression cHandle, HCkString outStr);
const char *CkCompression_endCompressStringENC(HCkCompression 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)
HCkTask CkCompression_EndCompressStringENCAsync(HCkCompression 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 CkCompression_EndDecompressBytes(HCkCompression cHandle, HCkByteData 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)
HCkTask CkCompression_EndDecompressBytesAsync(HCkCompression 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 CkCompression_EndDecompressBytesENC(HCkCompression cHandle, HCkByteData 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)
HCkTask CkCompression_EndDecompressBytesENCAsync(HCkCompression 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 CkCompression_EndDecompressString(HCkCompression cHandle, HCkString outStr);
const char *CkCompression_endDecompressString(HCkCompression 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)
HCkTask CkCompression_EndDecompressStringAsync(HCkCompression 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 CkCompression_EndDecompressStringENC(HCkCompression cHandle, HCkString outStr);
const char *CkCompression_endDecompressStringENC(HCkCompression 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)
HCkTask CkCompression_EndDecompressStringENCAsync(HCkCompression 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 CkCompression_MoreCompressBytes(HCkCompression cHandle, HCkByteData data, HCkByteData outData);

(See BeginCompressBytes)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreCompressBytesAsync (1)
HCkTask CkCompression_MoreCompressBytesAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_MoreCompressBytesENC(HCkCompression cHandle, HCkByteData data, HCkString outStr);
const char *CkCompression_moreCompressBytesENC(HCkCompression cHandle, HCkByteData data);

(See BeginCompressBytesENC)

Returns TRUE for success, FALSE for failure.

top
MoreCompressBytesENCAsync (1)
HCkTask CkCompression_MoreCompressBytesENCAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_MoreCompressString(HCkCompression cHandle, const char *str, HCkByteData outData);

(See BeginCompressString)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreCompressStringAsync (1)
HCkTask CkCompression_MoreCompressStringAsync(HCkCompression cHandle, const char *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 CkCompression_MoreCompressStringENC(HCkCompression cHandle, const char *str, HCkString outStr);
const char *CkCompression_moreCompressStringENC(HCkCompression cHandle, const char *str);

(See BeginCompressStringENC)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreCompressStringENCAsync (1)
HCkTask CkCompression_MoreCompressStringENCAsync(HCkCompression cHandle, const char *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 CkCompression_MoreDecompressBytes(HCkCompression cHandle, HCkByteData data, HCkByteData outData);

(See BeginDecompressBytes)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreDecompressBytesAsync (1)
HCkTask CkCompression_MoreDecompressBytesAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_MoreDecompressBytesENC(HCkCompression cHandle, const char *str, HCkByteData 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)
HCkTask CkCompression_MoreDecompressBytesENCAsync(HCkCompression cHandle, const char *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 CkCompression_MoreDecompressString(HCkCompression cHandle, HCkByteData data, HCkString outStr);
const char *CkCompression_moreDecompressString(HCkCompression cHandle, HCkByteData data);

(See BeginDecompressString)

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
MoreDecompressStringAsync (1)
HCkTask CkCompression_MoreDecompressStringAsync(HCkCompression cHandle, HCkByteData 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 CkCompression_MoreDecompressStringENC(HCkCompression cHandle, const char *str, HCkString outStr);
const char *CkCompression_moreDecompressStringENC(HCkCompression cHandle, const char *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)
HCkTask CkCompression_MoreDecompressStringENCAsync(HCkCompression cHandle, const char *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 CkCompression_SaveLastError(HCkCompression cHandle, const char *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 CkCompression_UnlockComponent(HCkCompression cHandle, const char *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