Compression C Reference Documentation
Compression
Current Version: 11.4.0
Provides a flexible and efficient API for compressing and decompressing data in memory, files, and streams. It supports multiple compression algorithms, chunked processing for large data, and optional encoding for easy transport or storage.
Key Features
- Multiple Compression Algorithms
deflatezlib(deflate with header)bzip2lzw
- Flexible Data Types
- Byte arrays
- Strings (with configurable charset)
BinDataandStringBuilder- Files and streams
- Streaming Support
- Compress/decompress arbitrarily large data with constant memory usage
- Ideal for files, sockets, or continuous data streams
- Chunked Processing
- Process data incrementally using
FirstChunkandLastChunk - Replace older Begin/More/End patterns
- Process data incrementally using
- Encoded Output Options
- Return compressed data as:
- Base64
- Hex
- 20+ other encodings
- Return compressed data as:
- Integrated Compression + Encryption
- Combine compression and encryption in a single operation
Create/Dispose
HCkCompression instance = CkCompression_Create(); // ... CkCompression_Dispose(instance);
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.
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
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.
See Also:C Example using Callback Functions
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.
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.
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_putAlgorithm(HCkCompression cHandle, const char *newVal);
const char *CkCompression_algorithm(HCkCompression cHandle);
Specifies the compression algorithm to use. Supported values are
deflate, zlib, bzip2, and lzw.
The zlib option is the deflate algorithm with a zlib header.
Note: ppmd is deprecated and should not be used.
It was only available on 32-bit systems and specifically used the J variant.
New applications should use one of the supported algorithms listed above.
Charset
void CkCompression_putCharset(HCkCompression cHandle, const char *newVal);
const char *CkCompression_charset(HCkCompression cHandle);
Specifies the character encoding used when converting text to bytes before compression, and bytes back to text after decompression.
The current default is the computer’s ANSI charset, such as Windows-1252 on many
Western Windows systems. However, most modern applications should explicitly set
this property to utf-8.
Recommendation: Set Charset = "utf-8" unless you
specifically need compatibility with another encoding.
DebugLogFilePath
void CkCompression_putDebugLogFilePath(HCkCompression cHandle, const char *newVal);
const char *CkCompression_debugLogFilePath(HCkCompression cHandle);
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
DeflateLevel
void CkCompression_putDeflateLevel(HCkCompression cHandle, int newVal);
Sets the compression level used by the deflate and zlib
algorithms.
0means no compression.9means maximum compression.- The default value is
6.
Higher values may produce smaller output but can require more processing time.
topEncodingMode
void CkCompression_putEncodingMode(HCkCompression cHandle, const char *newVal);
const char *CkCompression_encodingMode(HCkCompression cHandle);
Specifies the text encoding used by methods whose names end in ENC,
such as CompressBytesENC and DecompressStringENC.
Compression methods ending in ENC return compressed binary data as
an encoded string. Decompression methods ending in ENC expect the
input string to use this same encoding.
Valid values include:
base64hexurlquoted-printable
FirstChunk
void CkCompression_putFirstChunk(HCkCompression cHandle, BOOL newVal);
Indicates that the next chunk-aware compression or decompression call is the first chunk in a sequence.
The default value is TRUE
When both FirstChunk and LastChunk are
TRUE
HeartbeatMs
void CkCompression_putHeartbeatMs(HCkCompression cHandle, int newVal);
Specifies the interval, in milliseconds, between AbortCheck event
callbacks.
This allows an application to periodically check whether a long-running operation should be aborted.
The default value is 0, which disables AbortCheck
callbacks.
LastChunk
void CkCompression_putLastChunk(HCkCompression cHandle, BOOL newVal);
Indicates that the next chunk-aware compression or decompression call is the final chunk in a sequence.
The default value is TRUE
When both FirstChunk and LastChunk are
TRUE
LastErrorHtml
const char *CkCompression_lastErrorHtml(HCkCompression cHandle);
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
const char *CkCompression_lastErrorText(HCkCompression cHandle);
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
const char *CkCompression_lastErrorXml(HCkCompression cHandle);
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
void CkCompression_putLastMethodSuccess(HCkCompression cHandle, BOOL newVal);
Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
UncommonOptions
void CkCompression_putUncommonOptions(HCkCompression cHandle, const char *newVal);
const char *CkCompression_uncommonOptions(HCkCompression cHandle);
Provides a way to enable specialized or uncommon behavior. This property normally remains empty.
It may be set to a comma-separated list of keywords.
Supported option:
-
Crypt2CompressHdr— Duplicates the compression/decompression header behavior used by the deprecated and removed Crypt2 compression functions.
Utf8
void CkCompression_putUtf8(HCkCompression cHandle, BOOL newVal);
When set to TRUE, all const char * arguments and return values are interpreted as UTF-8 strings. When set to FALSE, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is TRUE. Before v11.0.0, it was FALSE.
VerboseLogging
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.
Version
const char *CkCompression_version(HCkCompression cHandle);
Methods
CompressBd
Compresses the data contained in a BinData object.
The BinData object is modified to contain the compressed result.
This method is not FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
CompressBdAsync (1)
Creates an asynchronous task to call the CompressBd method with the arguments provided.
Returns NULL on failure
CompressBd2
Compresses the data in one BinData object and appends the
compressed output to another BinData object.
The input BinData is not modified.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
CompressBd2Async (1)
Creates an asynchronous task to call the CompressBd2 method with the arguments provided.
Returns NULL on failure
CompressEncryptFile
Compresses and encrypts a file, writing the result to a destination file.
The compression and encryption are performed internally in streaming mode, so files of any size can be processed without loading the entire file into memory.
Returns TRUE for success, FALSE for failure.
CompressEncryptFileAsync (1)
Creates an asynchronous task to call the CompressEncryptFile method with the arguments provided.
Returns NULL on failure
CompressFile
Compresses a source file and writes the compressed data to a destination file.
The file is processed internally in streaming mode, allowing files of any size to be compressed with stable memory usage.
Returns TRUE for success, FALSE for failure.
CompressFileAsync (1)
Creates an asynchronous task to call the CompressFile method with the arguments provided.
Returns NULL on failure
CompressSb
Compresses the text contained in a StringBuilder and appends the
compressed bytes to a BinData object.
Text is converted to bytes according to the Charset property.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
CompressSbAsync (1)
Creates an asynchronous task to call the CompressSb method with the arguments provided.
Returns NULL on failure
CompressStream
Compresses data from a stream source and writes the compressed data to the stream sink.
The operation is performed in streaming mode, making it suitable for very large or even continuous streams while maintaining stable memory usage.
Returns TRUE for success, FALSE for failure.
CompressStreamAsync (1)
Creates an asynchronous task to call the CompressStream method with the arguments provided.
Returns NULL on failure
CompressStringENC
const char *CkCompression_compressStringENC(HCkCompression cHandle, const char *str);
Compresses a string and returns the compressed result as an encoded string.
The string is first converted to bytes using Charset, then
compressed, and finally encoded according to EncodingMode.
This method is not FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
CompressStringENCAsync (1)
Creates an asynchronous task to call the CompressStringENC method with the arguments provided.
Returns NULL on failure
DecompressBd
Decompresses the compressed data contained in a BinData object.
The BinData object is modified to contain the decompressed result.
This method is not FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
DecompressBdAsync (1)
Creates an asynchronous task to call the DecompressBd method with the arguments provided.
Returns NULL on failure
DecompressBd2
Decompresses the data in one BinData object and appends the
decompressed output to another BinData object.
The input BinData is not modified.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
DecompressBd2Async (1)
Creates an asynchronous task to call the DecompressBd2 method with the arguments provided.
Returns NULL on failure
DecompressFile
Decompresses a source file and writes the decompressed data to a destination file.
The file is processed internally in streaming mode, allowing files of any size to be decompressed without loading the entire file into memory.
Returns TRUE for success, FALSE for failure.
DecompressFileAsync (1)
Creates an asynchronous task to call the DecompressFile method with the arguments provided.
Returns NULL on failure
DecompressSb
Decompresses compressed data from a BinData object and appends the
resulting text to a StringBuilder.
The decompressed bytes are converted to text using the Charset
property.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
DecompressSbAsync (1)
Creates an asynchronous task to call the DecompressSb method with the arguments provided.
Returns NULL on failure
DecompressStream
Decompresses data from a stream source and writes the decompressed data to the stream sink.
The operation is performed in streaming mode, making it suitable for very large or continuous streams while maintaining stable memory usage.
Returns TRUE for success, FALSE for failure.
DecompressStreamAsync (1)
Creates an asynchronous task to call the DecompressStream method with the arguments provided.
Returns NULL on failure
DecompressStringENC
const char *CkCompression_decompressStringENC(HCkCompression cHandle, const char *encodedCompressedData);
Decompresses compressed data supplied as an encoded string and returns the resulting text.
The input string is decoded according to EncodingMode, then
decompressed. The resulting bytes are converted to text using
Charset.
This method is not FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
DecompressStringENCAsync (1)
Creates an asynchronous task to call the DecompressStringENC method with the arguments provided.
Returns NULL on failure
DecryptDecompressFile
Decrypts and decompresses a file, writing the restored data to a destination file.
This is the reverse operation of CompressEncryptFile.
Returns TRUE for success, FALSE for failure.
DecryptDecompressFileAsync (1)
Creates an asynchronous task to call the DecryptDecompressFile method with the arguments provided.
Returns NULL on failure
LoadTaskCaller
Deprecated
BeginCompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2 .
Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).
Returns TRUE for success, FALSE for failure.
BeginCompressBytes2
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).
Returns TRUE for success, FALSE for failure.
topBeginCompressBytesENC
const char *CkCompression_beginCompressBytesENC(HCkCompression cHandle, HCkByteData data);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytesENC, followed by 0 or more calls to MoreCompressedBytesENC, and ending with a final call to EndCompressBytesENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).
Returns TRUE for success, FALSE for failure.
topBeginCompressString
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Large amounts of string data may be compressed in chunks by first calling BeginCompressString, followed by 0 or more calls to MoreCompressedString, and ending with a final call to EndCompressString. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).
Returns TRUE for success, FALSE for failure.
BeginCompressStringENC
const char *CkCompression_beginCompressStringENC(HCkCompression cHandle, const char *str);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Large amounts of string data may be compressed in chunks by first calling BeginCompressStringENC, followed by 0 or more calls to MoreCompressedStringENC, and ending with a final call to EndCompressStringENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).
Returns TRUE for success, FALSE for failure.
BeginDecompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.
Returns TRUE for success, FALSE for failure.
BeginDecompressBytes2
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.
Returns TRUE for success, FALSE for failure.
topBeginDecompressBytesENC
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytesENC, followed by 0 or more calls to MoreDecompressedBytesENC, and ending with a final call to EndDecompressBytesENC. Each call returns 0 or more bytes of decompressed data.
Returns TRUE for success, FALSE for failure.
topBeginDecompressString
const char *CkCompression_beginDecompressString(HCkCompression cHandle, HCkByteData data);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressString, followed by 0 or more calls to MoreDecompressedString, and ending with a final call to EndDecompressString. Each call returns 0 or more characters of decompressed text.
Returns TRUE for success, FALSE for failure.
BeginDecompressStringENC
const char *CkCompression_beginDecompressStringENC(HCkCompression cHandle, const char *str);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
A compressed data stream may be decompressed in chunks by first calling BeginDecompressStringENC, followed by 0 or more calls to MoreDecompressedStringENC, and ending with a final call to EndDecompressStringENC. Each call returns 0 or more characters of decompressed text.
Returns TRUE for success, FALSE for failure.
topCompressBytes Deprecated
Compresses a byte array and returns the compressed bytes.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topCompressBytesAsync Deprecated (1)
Creates an asynchronous task to call the CompressBytes method with the arguments provided.
Returns NULL on failure
CompressBytes2 Deprecated
Compresses byte data passed by pointer and size, and returns the compressed bytes.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topCompressBytesENC Deprecated
const char *CkCompression_compressBytesENC(HCkCompression cHandle, HCkByteData data);
Compresses a byte array and returns the compressed result as an encoded string.
The output encoding is controlled by EncodingMode.
This method is not FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topCompressBytesENCAsync Deprecated (1)
Creates an asynchronous task to call the CompressBytesENC method with the arguments provided.
Returns NULL on failure
CompressStr Deprecated
Compresses a string and appends the compressed bytes to a BinData
object.
The string is converted to bytes using the charset specified by the
Charset property.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topCompressStrAsync Deprecated (1)
Creates an asynchronous task to call the CompressStr method with the arguments provided.
Returns NULL on failure
CompressString Deprecated
Compresses a string and returns the compressed bytes.
The string is converted to bytes using the Charset property.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topCompressStringAsync Deprecated (1)
Creates an asynchronous task to call the CompressString method with the arguments provided.
Returns NULL on failure
DecompressBytes Deprecated
Decompresses compressed byte data and returns the decompressed bytes.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topDecompressBytesAsync Deprecated (1)
Creates an asynchronous task to call the DecompressBytes method with the arguments provided.
Returns NULL on failure
DecompressBytes2 Deprecated
Decompresses compressed byte data passed by pointer and size, and returns the decompressed bytes.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topDecompressBytesENC Deprecated
Decompresses compressed data supplied as an encoded string and returns the decompressed bytes.
The input string is decoded according to EncodingMode before being
decompressed.
Returns TRUE for success, FALSE for failure.
topDecompressBytesENCAsync Deprecated (1)
Creates an asynchronous task to call the DecompressBytesENC method with the arguments provided.
Returns NULL on failure
DecompressString Deprecated
const char *CkCompression_decompressString(HCkCompression cHandle, HCkByteData data);
Decompresses compressed byte data and returns the resulting string.
The decompressed bytes are converted to text using the Charset
property.
This method is FirstChunk / LastChunk aware.
Returns TRUE for success, FALSE for failure.
topEndCompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytes)
Returns TRUE for success, FALSE for failure.
EndCompressBytesENC
const char *CkCompression_endCompressBytesENC(HCkCompression cHandle);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytesENC)
Returns TRUE for success, FALSE for failure.
topEndCompressString
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressString)
Returns TRUE for success, FALSE for failure.
EndCompressStringENC
const char *CkCompression_endCompressStringENC(HCkCompression cHandle);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressStringENC)
Returns TRUE for success, FALSE for failure.
EndDecompressBytes
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressBytes)
Returns TRUE for success, FALSE for failure.
EndDecompressBytesENC
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
(See BeginDecompressBytesENC)
Returns TRUE for success, FALSE for failure.
topEndDecompressString
const char *CkCompression_endDecompressString(HCkCompression cHandle);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressString)
Returns TRUE for success, FALSE for failure.
EndDecompressStringENC
const char *CkCompression_endDecompressStringENC(HCkCompression cHandle);
The Begin*, More*, and End* methods are replaced with the FirstChunk and LastChunk properties used in combination with FirstChunk/LastChunk aware methods, such as CompressStr and DecompressBd2.
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.
(See BeginDecompressStringENC)
Returns TRUE for success, FALSE for failure.
topMoreCompressBytes
(See BeginCompressBytes)
Returns TRUE for success, FALSE for failure.
MoreCompressBytes2
MoreCompressBytesENC
const char *CkCompression_moreCompressBytesENC(HCkCompression cHandle, HCkByteData data);
MoreCompressString
(See BeginCompressString)
Returns TRUE for success, FALSE for failure.
MoreCompressStringENC
const char *CkCompression_moreCompressStringENC(HCkCompression cHandle, const char *str);
(See BeginCompressStringENC)
Returns TRUE for success, FALSE for failure.
MoreDecompressBytes
(See BeginDecompressBytes)
Returns TRUE for success, FALSE for failure.
MoreDecompressBytes2
MoreDecompressBytesENC
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.
topMoreDecompressString
const char *CkCompression_moreDecompressString(HCkCompression cHandle, HCkByteData data);
(See BeginDecompressString)
Returns TRUE for success, FALSE for failure.
MoreDecompressStringENC
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