Compression Delphi DLL Reference Documentation
Compression
Current Version: 10.1.3
Implements the Bzip2, Deflate, and LZW compression algorithms.
Create/Dispose
var myObject: HCkCompression; begin myObject := CkCompression_Create(); // ... CkCompression_Dispose(myObject); end;
Creates an instance of the HCkCompression object and returns a handle (i.e. a 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.
Properties
Algorithm
procedure CkCompression_putAlgorithm(objHandle: HCkCompression; newPropVal: PWideChar); stdcall;
function CkCompression__algorithm(objHandle: HCkCompression): PWideChar; stdcall;
Specifies the compression algorithm: "deflate", "zlib", "bzip2", or "lzw". Note that "ppmd" is deprecated and should not be used. It was only available for 32-bit systems and specifically used the "J" variant. Please transition to one of the recommended algorithms.
See the notes about PWideChar memory ownership and validity.
topCharset
procedure CkCompression_putCharset(objHandle: HCkCompression; newPropVal: PWideChar); stdcall;
function CkCompression__charset(objHandle: HCkCompression): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topDebugLogFilePath
procedure CkCompression_putDebugLogFilePath(objHandle: HCkCompression; newPropVal: PWideChar); stdcall;
function CkCompression__debugLogFilePath(objHandle: HCkCompression): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
DeflateLevel
procedure CkCompression_putDeflateLevel(objHandle: HCkCompression; newPropVal: Integer); stdcall;
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.
topEncodingMode
procedure CkCompression_putEncodingMode(objHandle: HCkCompression; newPropVal: PWideChar); stdcall;
function CkCompression__encodingMode(objHandle: HCkCompression): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topHeartbeatMs
procedure CkCompression_putHeartbeatMs(objHandle: HCkCompression; newPropVal: Integer); stdcall;
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.
topLastErrorHtml
function CkCompression__lastErrorHtml(objHandle: HCkCompression): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastErrorText
function CkCompression__lastErrorText(objHandle: HCkCompression): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
LastErrorXml
function CkCompression__lastErrorXml(objHandle: HCkCompression): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topLastMethodSuccess
procedure CkCompression_putLastMethodSuccess(objHandle: HCkCompression; newPropVal: wordbool); stdcall;
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.
VerboseLogging
procedure CkCompression_putVerboseLogging(objHandle: HCkCompression; newPropVal: wordbool); stdcall;
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
function CkCompression__version(objHandle: HCkCompression): PWideChar; stdcall;
Version of the component/library, such as "10.1.0"
See the notes about PWideChar memory ownership and validity.
Methods
BeginCompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
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.
topBeginCompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
BeginCompressBytesENC
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__beginCompressBytesENC(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topBeginCompressBytesENCAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
BeginCompressString
str: PWideChar;
outData: HCkByteData): wordbool; stdcall;
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.
topBeginCompressStringAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
BeginCompressStringENC
str: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCompression__beginCompressStringENC(objHandle: HCkCompression;
str: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
BeginCompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
BeginDecompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
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.
topBeginDecompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginDecompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
BeginDecompressBytesENC
str: PWideChar;
outData: HCkByteData): wordbool; stdcall;
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.
topBeginDecompressBytesENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the BeginDecompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
BeginDecompressString
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__beginDecompressString(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topBeginDecompressStringAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginDecompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
BeginDecompressStringENC
str: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCompression__beginDecompressStringENC(objHandle: HCkCompression;
str: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topBeginDecompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the BeginDecompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressBd
binData: HCkBinData): wordbool; stdcall;
Compresses the data contained in a BinData object.
Returns True for success, False for failure.
CompressBdAsync (1)
binData: HCkBinData): HCkTask; stdcall;
Creates an asynchronous task to call the CompressBd method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
CompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the CompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressBytesENC
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__compressBytesENC(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topCompressBytesENCAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the CompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressEncryptFile
cryptParams: HCkJsonObject;
srcPath: PWideChar;
destPath: PWideChar): wordbool; stdcall;
Performs file-to-file compression and encryption. Files of any size may be compressed because the file is compressed and encrypted internally in streaming mode.
Returns True for success, False for failure.
CompressEncryptFileAsync (1)
cryptParams: HCkJsonObject;
srcPath: PWideChar;
destPath: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the CompressEncryptFile method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressFile
srcPath: PWideChar;
destPath: PWideChar): wordbool; stdcall;
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.
CompressFileAsync (1)
srcPath: PWideChar;
destPath: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the CompressFile method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressSb
sb: HCkStringBuilder;
binData: HCkBinData): wordbool; stdcall;
Compresses the contents of sb and appends the compressed bytes to binData.
Returns True for success, False for failure.
topCompressSbAsync (1)
sb: HCkStringBuilder;
binData: HCkBinData): HCkTask; stdcall;
Creates an asynchronous task to call the CompressSb method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressStream
strm: HCkStream): wordbool; stdcall;
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.
CompressStreamAsync (1)
strm: HCkStream): HCkTask; stdcall;
Creates an asynchronous task to call the CompressStream method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressString
str: PWideChar;
outData: HCkByteData): wordbool; stdcall;
CompressStringAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the CompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
CompressStringENC
str: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCompression__compressStringENC(objHandle: HCkCompression;
str: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
CompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the CompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressBd
binData: HCkBinData): wordbool; stdcall;
Decompresses the data contained in a BinData object.
Returns True for success, False for failure.
DecompressBdAsync (1)
binData: HCkBinData): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressBd method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
DecompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressBytesENC
encodedCompressedData: PWideChar;
outData: HCkByteData): wordbool; stdcall;
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.
topDecompressBytesENCAsync (1)
encodedCompressedData: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressFile
srcPath: PWideChar;
destPath: PWideChar): wordbool; stdcall;
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.
DecompressFileAsync (1)
srcPath: PWideChar;
destPath: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressFile method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressSb
binData: HCkBinData;
sb: HCkStringBuilder): wordbool; stdcall;
Decompresses the contents of binData and appends the decompressed string to sb.
Returns True for success, False for failure.
topDecompressSbAsync (1)
binData: HCkBinData;
sb: HCkStringBuilder): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressSb method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressStream
strm: HCkStream): wordbool; stdcall;
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.
DecompressStreamAsync (1)
strm: HCkStream): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressStream method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressString
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__decompressString(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
Takes compressed bytes, decompresses, and returns the resulting string.
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
topDecompressStringAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecompressStringENC
encodedCompressedData: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCompression__decompressStringENC(objHandle: HCkCompression;
encodedCompressedData: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
DecompressStringENCAsync (1)
encodedCompressedData: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
DecryptDecompressFile
cryptParams: HCkJsonObject;
srcPath: PWideChar;
destPath: PWideChar): wordbool; stdcall;
Performs file-to-file decryption and decompression.
Returns True for success, False for failure.
DecryptDecompressFileAsync (1)
cryptParams: HCkJsonObject;
srcPath: PWideChar;
destPath: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the DecryptDecompressFile method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndCompressBytes
outData: HCkByteData): wordbool; stdcall;
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytes)
Returns True for success, False for failure.
topEndCompressBytesAsync (1)
Creates an asynchronous task to call the EndCompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndCompressBytesENC
outStr: HCkString): wordbool; stdcall;
function CkCompression__endCompressBytesENC(objHandle: HCkCompression): PWideChar; stdcall;
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressBytesENC)
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
topEndCompressBytesENCAsync (1)
Creates an asynchronous task to call the EndCompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndCompressString
outData: HCkByteData): wordbool; stdcall;
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressString)
Returns True for success, False for failure.
topEndCompressStringAsync (1)
Creates an asynchronous task to call the EndCompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndCompressStringENC
outStr: HCkString): wordbool; stdcall;
function CkCompression__endCompressStringENC(objHandle: HCkCompression): PWideChar; stdcall;
Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.
(See BeginCompressStringENC)
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
EndCompressStringENCAsync (1)
Creates an asynchronous task to call the EndCompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndDecompressBytes
outData: HCkByteData): wordbool; stdcall;
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressBytes)
Returns True for success, False for failure.
topEndDecompressBytesAsync (1)
Creates an asynchronous task to call the EndDecompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndDecompressBytesENC
outData: HCkByteData): wordbool; stdcall;
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.
topEndDecompressBytesENCAsync (1)
Creates an asynchronous task to call the EndDecompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndDecompressString
outStr: HCkString): wordbool; stdcall;
function CkCompression__endDecompressString(objHandle: HCkCompression): PWideChar; stdcall;
Called to finalize the decompression stream and return any remaining (buffered) decompressed data.
(See BeginDecompressString)
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
EndDecompressStringAsync (1)
Creates an asynchronous task to call the EndDecompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
EndDecompressStringENC
outStr: HCkString): wordbool; stdcall;
function CkCompression__endDecompressStringENC(objHandle: HCkCompression): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topEndDecompressStringENCAsync (1)
Creates an asynchronous task to call the EndDecompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
LoadTaskCaller
MoreCompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
MoreCompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
MoreCompressBytesENC
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__moreCompressBytesENC(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
(See BeginCompressBytesENC)
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
topMoreCompressBytesENCAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
MoreCompressString
str: PWideChar;
outData: HCkByteData): wordbool; stdcall;
MoreCompressStringAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
MoreCompressStringENC
str: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCompression__moreCompressStringENC(objHandle: HCkCompression;
str: PWideChar): PWideChar; stdcall;
(See BeginCompressStringENC)
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
MoreCompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
MoreDecompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
MoreDecompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreDecompressBytes method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
MoreDecompressBytesENC
str: PWideChar;
outData: HCkByteData): wordbool; stdcall;
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.
topMoreDecompressBytesENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the MoreDecompressBytesENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
MoreDecompressString
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__moreDecompressString(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
(See BeginDecompressString)
Returns True for success, False for failure.
See the notes about PWideChar memory ownership and validity.
topMoreDecompressStringAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreDecompressString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
MoreDecompressStringENC
str: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCompression__moreDecompressStringENC(objHandle: HCkCompression;
str: PWideChar): PWideChar; stdcall;
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.
See the notes about PWideChar memory ownership and validity.
topMoreDecompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the MoreDecompressStringENC method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure