Compression Delphi DLL Reference Documentation

Compression

Current Version: 9.5.0.75

Data compression component implementing the PPMD, Bzip2, Deflate, and LZW compression algorithms. .NET, ActiveX, and C++ implementations provide progress monitoring and abort capabilities. Provides a unified API for all supported compression algorithms.

Create/Dispose

var
myObject: HCkCompression;

begin
myObject := CkCompression_Create();

// ...

CkCompression_Dispose(myObject);
end;
function CkCompression_Create: HCkCompression; stdcall;

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.

procedure CkCompression_Dispose(handle: HCkCompression); stdcall;

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_getAlgorithm(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
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.

top
Charset
procedure CkCompression_getCharset(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
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.

top
DebugLogFilePath
procedure CkCompression_getDebugLogFilePath(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DeflateLevel
function CkCompression_getDeflateLevel(objHandle: HCkCompression): Integer; stdcall;
procedure CkCompression_putDeflateLevel(objHandle: HCkCompression; newPropVal: Integer); stdcall;
Introduced in version 9.5.0.73

This property allows for customization of the compression level for the "deflate" and "zlib" compression algoirthms. ("zlib" is just the deflate algorithm with a zlib header.) A value of 0 = no compression, while 9 = maximum compression. The default is 6.

top
EncodingMode
procedure CkCompression_getEncodingMode(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
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.

top
LastErrorHtml
procedure CkCompression_getLastErrorHtml(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
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.

top
LastErrorText
procedure CkCompression_getLastErrorText(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
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.

top
LastErrorXml
procedure CkCompression_getLastErrorXml(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
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.

top
LastMethodSuccess
function CkCompression_getLastMethodSuccess(objHandle: HCkCompression): wordbool; stdcall;
procedure CkCompression_putLastMethodSuccess(objHandle: HCkCompression; newPropVal: wordbool); stdcall;
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = True and failure = False.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
VerboseLogging
function CkCompression_getVerboseLogging(objHandle: HCkCompression): wordbool; stdcall;
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.

top
Version
procedure CkCompression_getVersion(objHandle: HCkCompression; outPropVal: HCkString); stdcall;
function CkCompression__version(objHandle: HCkCompression): PWideChar; stdcall;

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

top

Methods

BeginCompressBytes
function CkCompression_BeginCompressBytes(objHandle: HCkCompression;
    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.

More Information and Examples
top
BeginCompressBytesAsync (1)
function CkCompression_BeginCompressBytesAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
BeginCompressBytesENC
function CkCompression_BeginCompressBytesENC(objHandle: HCkCompression;
    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.

top
BeginCompressBytesENCAsync (1)
function CkCompression_BeginCompressBytesENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
BeginCompressString
function CkCompression_BeginCompressString(objHandle: HCkCompression;
    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.

More Information and Examples
top
BeginCompressStringAsync (1)
function CkCompression_BeginCompressStringAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
BeginCompressStringENC
function CkCompression_BeginCompressStringENC(objHandle: HCkCompression;
    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.

More Information and Examples
top
BeginCompressStringENCAsync (1)
function CkCompression_BeginCompressStringENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
BeginDecompressBytes
function CkCompression_BeginDecompressBytes(objHandle: HCkCompression;
    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.

More Information and Examples
top
BeginDecompressBytesAsync (1)
function CkCompression_BeginDecompressBytesAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
BeginDecompressBytesENC
function CkCompression_BeginDecompressBytesENC(objHandle: HCkCompression;
    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.

top
BeginDecompressBytesENCAsync (1)
function CkCompression_BeginDecompressBytesENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
BeginDecompressString
function CkCompression_BeginDecompressString(objHandle: HCkCompression;
    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.

More Information and Examples
top
BeginDecompressStringAsync (1)
function CkCompression_BeginDecompressStringAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
BeginDecompressStringENC
function CkCompression_BeginDecompressStringENC(objHandle: HCkCompression;
    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.

top
BeginDecompressStringENCAsync (1)
function CkCompression_BeginDecompressStringENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
CompressBd
function CkCompression_CompressBd(objHandle: HCkCompression;
    binData: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns True for success, False for failure.

top
CompressBdAsync (1)
function CkCompression_CompressBdAsync(objHandle: HCkCompression;
    binData: HCkBinData): HCkTask; stdcall;
Introduced in version 9.5.0.66

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

Returns nil on failure

top
CompressBytes
function CkCompression_CompressBytes(objHandle: HCkCompression;
    data: HCkByteData;
    outData: HCkByteData): wordbool; stdcall;

Compresses byte data.

Returns True for success, False for failure.

More Information and Examples
top
CompressBytesAsync (1)
function CkCompression_CompressBytesAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
CompressBytesENC
function CkCompression_CompressBytesENC(objHandle: HCkCompression;
    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.

top
CompressBytesENCAsync (1)
function CkCompression_CompressBytesENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
CompressFile
function CkCompression_CompressFile(objHandle: HCkCompression;
    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.

More Information and Examples
top
CompressFileAsync (1)
function CkCompression_CompressFileAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
CompressSb
function CkCompression_CompressSb(objHandle: HCkCompression;
    sb: HCkStringBuilder;
    binData: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.73

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

Returns True for success, False for failure.

top
CompressSbAsync (1)
function CkCompression_CompressSbAsync(objHandle: HCkCompression;
    sb: HCkStringBuilder;
    binData: HCkBinData): HCkTask; stdcall;
Introduced in version 9.5.0.73

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

Returns nil on failure

top
CompressStream
function CkCompression_CompressStream(objHandle: HCkCompression;
    strm: HCkStream): wordbool; stdcall;
Introduced in version 9.5.0.56

Compresses a stream. Internally, the strm's source is read, compressed, and the compressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be compressed with stable ungrowing memory usage.

Returns True for success, False for failure.

More Information and Examples
top
CompressStreamAsync (1)
function CkCompression_CompressStreamAsync(objHandle: HCkCompression;
    strm: HCkStream): HCkTask; stdcall;
Introduced in version 9.5.0.56

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

Returns nil on failure

top
CompressString
function CkCompression_CompressString(objHandle: HCkCompression;
    str: PWideChar;
    outData: HCkByteData): wordbool; stdcall;

Compresses a string.

Returns True for success, False for failure.

More Information and Examples
top
CompressStringAsync (1)
function CkCompression_CompressStringAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
CompressStringENC
function CkCompression_CompressStringENC(objHandle: HCkCompression;
    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.

More Information and Examples
top
CompressStringENCAsync (1)
function CkCompression_CompressStringENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
DecompressBd
function CkCompression_DecompressBd(objHandle: HCkCompression;
    binData: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns True for success, False for failure.

top
DecompressBdAsync (1)
function CkCompression_DecompressBdAsync(objHandle: HCkCompression;
    binData: HCkBinData): HCkTask; stdcall;
Introduced in version 9.5.0.66

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

Returns nil on failure

top
DecompressBytes
function CkCompression_DecompressBytes(objHandle: HCkCompression;
    data: HCkByteData;
    outData: HCkByteData): wordbool; stdcall;

The opposite of CompressBytes.

Returns True for success, False for failure.

More Information and Examples
top
DecompressBytesAsync (1)
function CkCompression_DecompressBytesAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
DecompressBytesENC
function CkCompression_DecompressBytesENC(objHandle: HCkCompression;
    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.

top
DecompressBytesENCAsync (1)
function CkCompression_DecompressBytesENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
DecompressFile
function CkCompression_DecompressFile(objHandle: HCkCompression;
    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.

More Information and Examples
top
DecompressFileAsync (1)
function CkCompression_DecompressFileAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
DecompressSb
function CkCompression_DecompressSb(objHandle: HCkCompression;
    binData: HCkBinData;
    sb: HCkStringBuilder): wordbool; stdcall;
Introduced in version 9.5.0.73

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

Returns True for success, False for failure.

top
DecompressSbAsync (1)
function CkCompression_DecompressSbAsync(objHandle: HCkCompression;
    binData: HCkBinData;
    sb: HCkStringBuilder): HCkTask; stdcall;
Introduced in version 9.5.0.73

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

Returns nil on failure

top
DecompressStream
function CkCompression_DecompressStream(objHandle: HCkCompression;
    strm: HCkStream): wordbool; stdcall;
Introduced in version 9.5.0.56

Decompresses a stream. Internally, the strm's source is read, decompressed, and the decompressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be decompressed with stable ungrowing memory usage.

Returns True for success, False for failure.

More Information and Examples
top
DecompressStreamAsync (1)
function CkCompression_DecompressStreamAsync(objHandle: HCkCompression;
    strm: HCkStream): HCkTask; stdcall;
Introduced in version 9.5.0.56

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

Returns nil on failure

top
DecompressString
function CkCompression_DecompressString(objHandle: HCkCompression;
    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.

More Information and Examples
top
DecompressStringAsync (1)
function CkCompression_DecompressStringAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
DecompressStringENC
function CkCompression_DecompressStringENC(objHandle: HCkCompression;
    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.

More Information and Examples
top
DecompressStringENCAsync (1)
function CkCompression_DecompressStringENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
EndCompressBytes
function CkCompression_EndCompressBytes(objHandle: HCkCompression;
    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.

More Information and Examples
top
EndCompressBytesAsync (1)
function CkCompression_EndCompressBytesAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
EndCompressBytesENC
function CkCompression_EndCompressBytesENC(objHandle: HCkCompression;
    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.

top
EndCompressBytesENCAsync (1)
function CkCompression_EndCompressBytesENCAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
EndCompressString
function CkCompression_EndCompressString(objHandle: HCkCompression;
    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.

More Information and Examples
top
EndCompressStringAsync (1)
function CkCompression_EndCompressStringAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
EndCompressStringENC
function CkCompression_EndCompressStringENC(objHandle: HCkCompression;
    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.

More Information and Examples
top
EndCompressStringENCAsync (1)
function CkCompression_EndCompressStringENCAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
EndDecompressBytes
function CkCompression_EndDecompressBytes(objHandle: HCkCompression;
    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.

More Information and Examples
top
EndDecompressBytesAsync (1)
function CkCompression_EndDecompressBytesAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
EndDecompressBytesENC
function CkCompression_EndDecompressBytesENC(objHandle: HCkCompression;
    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.

top
EndDecompressBytesENCAsync (1)
function CkCompression_EndDecompressBytesENCAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
EndDecompressString
function CkCompression_EndDecompressString(objHandle: HCkCompression;
    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.

More Information and Examples
top
EndDecompressStringAsync (1)
function CkCompression_EndDecompressStringAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
EndDecompressStringENC
function CkCompression_EndDecompressStringENC(objHandle: HCkCompression;
    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.

top
EndDecompressStringENCAsync (1)
function CkCompression_EndDecompressStringENCAsync(objHandle: HCkCompression): HCkTask; stdcall;

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

Returns nil on failure

top
MoreCompressBytes
function CkCompression_MoreCompressBytes(objHandle: HCkCompression;
    data: HCkByteData;
    outData: HCkByteData): wordbool; stdcall;

(See BeginCompressBytes)

Returns True for success, False for failure.

More Information and Examples
top
MoreCompressBytesAsync (1)
function CkCompression_MoreCompressBytesAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
MoreCompressBytesENC
function CkCompression_MoreCompressBytesENC(objHandle: HCkCompression;
    data: HCkByteData;
    outStr: HCkString): wordbool; stdcall;
function CkCompression__moreCompressBytesENC(objHandle: HCkCompression;
    data: HCkByteData): PWideChar; stdcall;

(See BeginCompressBytesENC)

Returns True for success, False for failure.

top
MoreCompressBytesENCAsync (1)
function CkCompression_MoreCompressBytesENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
MoreCompressString
function CkCompression_MoreCompressString(objHandle: HCkCompression;
    str: PWideChar;
    outData: HCkByteData): wordbool; stdcall;

(See BeginCompressString)

Returns True for success, False for failure.

More Information and Examples
top
MoreCompressStringAsync (1)
function CkCompression_MoreCompressStringAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
MoreCompressStringENC
function CkCompression_MoreCompressStringENC(objHandle: HCkCompression;
    str: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkCompression__moreCompressStringENC(objHandle: HCkCompression;
    str: PWideChar): PWideChar; stdcall;

(See BeginCompressStringENC)

Returns True for success, False for failure.

More Information and Examples
top
MoreCompressStringENCAsync (1)
function CkCompression_MoreCompressStringENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
MoreDecompressBytes
function CkCompression_MoreDecompressBytes(objHandle: HCkCompression;
    data: HCkByteData;
    outData: HCkByteData): wordbool; stdcall;

(See BeginDecompressBytes)

Returns True for success, False for failure.

More Information and Examples
top
MoreDecompressBytesAsync (1)
function CkCompression_MoreDecompressBytesAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
MoreDecompressBytesENC
function CkCompression_MoreDecompressBytesENC(objHandle: HCkCompression;
    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.

top
MoreDecompressBytesENCAsync (1)
function CkCompression_MoreDecompressBytesENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
MoreDecompressString
function CkCompression_MoreDecompressString(objHandle: HCkCompression;
    data: HCkByteData;
    outStr: HCkString): wordbool; stdcall;
function CkCompression__moreDecompressString(objHandle: HCkCompression;
    data: HCkByteData): PWideChar; stdcall;

(See BeginDecompressString)

Returns True for success, False for failure.

More Information and Examples
top
MoreDecompressStringAsync (1)
function CkCompression_MoreDecompressStringAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
MoreDecompressStringENC
function CkCompression_MoreDecompressStringENC(objHandle: HCkCompression;
    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.

top
MoreDecompressStringENCAsync (1)
function CkCompression_MoreDecompressStringENCAsync(objHandle: HCkCompression;
    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.)

Returns nil on failure

top
SaveLastError
function CkCompression_SaveLastError(objHandle: HCkCompression;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

top
UnlockComponent
function CkCompression_UnlockComponent(objHandle: HCkCompression;
    unlockCode: PWideChar): wordbool; stdcall;

Unlocks the component allowing for the full functionality to be used. The component may be used fully-functional for the 1st 30-days after download by passing an arbitrary string to this method. If for some reason you do not receive the full 30-day trial, send email to support@chilkatsoft.com for a temporary unlock code w/ an explicit expiration date. Upon purchase, a purchased unlock code is provided which should replace the temporary/arbitrary string passed to this method.

Returns True for success, False for failure.

top