Compression Delphi DLL Reference Documentation
Compression
Current Version: 9.5.0.98
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
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;
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.
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.
topDebugLogFilePath
procedure CkCompression_putDebugLogFilePath(objHandle: HCkCompression; newPropVal: PWideChar); stdcall;
function CkCompression__debugLogFilePath(objHandle: HCkCompression): PWideChar; stdcall;
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
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.
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 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.
topLastErrorText
function CkCompression__lastErrorText(objHandle: HCkCompression): PWideChar; stdcall;
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.
LastErrorXml
function CkCompression__lastErrorXml(objHandle: HCkCompression): PWideChar; stdcall;
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.
topLastMethodSuccess
procedure CkCompression_putLastMethodSuccess(objHandle: HCkCompression; newPropVal: wordbool); stdcall;
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.
topVerboseLogging
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.
topVersion
function CkCompression__version(objHandle: HCkCompression): PWideChar; stdcall;
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.
BeginCompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topBeginCompressBytes2
pByteData: pbyte;
szByteData: LongWord;
outBytes: 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.
topBeginCompressBytesENC
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.
topBeginCompressBytesENCAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topBeginCompressString
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.
BeginCompressStringAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topBeginCompressStringENC
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.
BeginCompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the BeginCompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topBeginDecompressBytes
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.
BeginDecompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginDecompressBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topBeginDecompressBytes2
pByteData: pbyte;
szByteData: LongWord;
outBytes: 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.
topBeginDecompressBytesENC
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topBeginDecompressString
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.
BeginDecompressStringAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the BeginDecompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topBeginDecompressStringENC
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.
topBeginDecompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the BeginDecompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressBd
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressBytes
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressBytes2
pByteData: pbyte;
szByteData: LongWord;
outBytes: HCkByteData): wordbool; stdcall;
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.
CompressBytesENCAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the CompressBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressFile
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressSb
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressStream
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressString
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topCompressStringENC
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.
CompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the CompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressBd
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
The opposite of CompressBytes.
Returns True for success, False for failure.
DecompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressBytes2
pByteData: pbyte;
szByteData: LongWord;
outBytes: HCkByteData): wordbool; stdcall;
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.
DecompressBytesENCAsync (1)
encodedCompressedData: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressFile
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressSb
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressStream
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressString
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.
DecompressStringAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topDecompressStringENC
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.
DecompressStringENCAsync (1)
encodedCompressedData: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the DecompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndCompressBytes
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.
EndCompressBytesAsync (1)
Creates an asynchronous task to call the EndCompressBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndCompressBytesENC
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.
topEndCompressBytesENCAsync (1)
Creates an asynchronous task to call the EndCompressBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndCompressString
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.
EndCompressStringAsync (1)
Creates an asynchronous task to call the EndCompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndCompressStringENC
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.
EndCompressStringENCAsync (1)
Creates an asynchronous task to call the EndCompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndDecompressBytes
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.
EndDecompressBytesAsync (1)
Creates an asynchronous task to call the EndDecompressBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndDecompressBytesENC
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndDecompressString
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.
EndDecompressStringAsync (1)
Creates an asynchronous task to call the EndDecompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEndDecompressStringENC
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.
topEndDecompressStringENCAsync (1)
Creates an asynchronous task to call the EndDecompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topLoadTaskCaller
MoreCompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
(See BeginCompressBytes)
Returns True for success, False for failure.
MoreCompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topMoreCompressBytes2
pByteData: pbyte;
szByteData: LongWord;
outBytes: HCkByteData): wordbool; stdcall;
MoreCompressBytesENC
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__moreCompressBytesENC(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
MoreCompressBytesENCAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressBytesENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topMoreCompressString
str: PWideChar;
outData: HCkByteData): wordbool; stdcall;
(See BeginCompressString)
Returns True for success, False for failure.
MoreCompressStringAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topMoreCompressStringENC
str: PWideChar;
outStr: HCkString): wordbool; stdcall;
function CkCompression__moreCompressStringENC(objHandle: HCkCompression;
str: PWideChar): PWideChar; stdcall;
(See BeginCompressStringENC)
Returns True for success, False for failure.
MoreCompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the MoreCompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topMoreDecompressBytes
data: HCkByteData;
outData: HCkByteData): wordbool; stdcall;
(See BeginDecompressBytes)
Returns True for success, False for failure.
MoreDecompressBytesAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreDecompressBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topMoreDecompressBytes2
pByteData: pbyte;
szByteData: LongWord;
outBytes: HCkByteData): wordbool; stdcall;
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. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topMoreDecompressString
data: HCkByteData;
outStr: HCkString): wordbool; stdcall;
function CkCompression__moreDecompressString(objHandle: HCkCompression;
data: HCkByteData): PWideChar; stdcall;
(See BeginDecompressString)
Returns True for success, False for failure.
MoreDecompressStringAsync (1)
data: HCkByteData): HCkTask; stdcall;
Creates an asynchronous task to call the MoreDecompressString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topMoreDecompressStringENC
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.
topMoreDecompressStringENCAsync (1)
str: PWideChar): HCkTask; stdcall;
Creates an asynchronous task to call the MoreDecompressStringENC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
topEvents
Chilkat supports event callbacks for the Delphi DLL starting in version 9.5.0.82.
AbortCheck
Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return True to abort; return False to continue (not abort)
PercentDone
Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).
The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.
Return True to abort; return False to continue (not abort)
ProgressInfo
A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.
TaskCompleted
Called in the background thread when an asynchronous task completes.