Compression DataFlex Reference Documentation

Compression

Current Version: 10.0.0

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.

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoCompression
Get Create(RefClass(cComChilkatCompression)) to hoCompression

Properties

Algorithm
Function ComAlgorithm Returns String
Procedure Set ComAlgorithm String value

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
Function ComCharset Returns String
Procedure Set ComCharset String value

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
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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.

More Information and Examples
top
DeflateLevel
Function ComDeflateLevel Returns Integer
Procedure Set ComDeflateLevel Integer value
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
Function ComEncodingMode Returns String
Procedure Set ComEncodingMode String value

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
LastBinaryResult
Function ComLastBinaryResult Returns Variant

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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 ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

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
LastStringResult
Function ComLastStringResult Returns String

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
Function ComLastStringResultLen Returns Integer

The length, in characters, of the string contained in the LastStringResult property.

top
VerboseLogging
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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
Function ComVersion Returns String

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

More Information and Examples
top

Methods

BeginCompressBytes
Function ComBeginCompressBytes Variant data Returns Variant

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 null on failure

More Information and Examples
top
BeginCompressBytesAsync (1)
Function ComBeginCompressBytesAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
BeginCompressBytesENC
Function ComBeginCompressBytesENC Variant data Returns String

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 null on failure

top
BeginCompressBytesENCAsync (1)
Function ComBeginCompressBytesENCAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
BeginCompressString
Function ComBeginCompressString String str Returns Variant

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 null on failure

More Information and Examples
top
BeginCompressStringAsync (1)
Function ComBeginCompressStringAsync String str Returns cComChilkatTask

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

Returns null on failure

top
BeginCompressStringENC
Function ComBeginCompressStringENC String str Returns String

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 null on failure

More Information and Examples
top
BeginCompressStringENCAsync (1)
Function ComBeginCompressStringENCAsync String str Returns cComChilkatTask

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

Returns null on failure

top
BeginDecompressBytes
Function ComBeginDecompressBytes Variant data Returns Variant

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 null on failure

More Information and Examples
top
BeginDecompressBytesAsync (1)
Function ComBeginDecompressBytesAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
BeginDecompressBytesENC
Function ComBeginDecompressBytesENC String str Returns Variant

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 null on failure

top
BeginDecompressBytesENCAsync (1)
Function ComBeginDecompressBytesENCAsync String str Returns cComChilkatTask

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

Returns null on failure

top
BeginDecompressString
Function ComBeginDecompressString Variant data Returns String

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 null on failure

More Information and Examples
top
BeginDecompressStringAsync (1)
Function ComBeginDecompressStringAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
BeginDecompressStringENC
Function ComBeginDecompressStringENC String str Returns String

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 null on failure

top
BeginDecompressStringENCAsync (1)
Function ComBeginDecompressStringENCAsync String str Returns cComChilkatTask

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

Returns null on failure

top
CompressBd
Function ComCompressBd cComChilkatBinData binData Returns Boolean
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 ComCompressBdAsync cComChilkatBinData binData Returns cComChilkatTask
Introduced in version 9.5.0.66

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

Returns null on failure

top
CompressBytes
Function ComCompressBytes Variant data Returns Variant

Compresses byte data.

Returns null on failure

More Information and Examples
top
CompressBytesAsync (1)
Function ComCompressBytesAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
CompressBytesENC
Function ComCompressBytesENC Variant data Returns String

Compresses bytes and returns the compressed data encoded to a string. The encoding (hex, base64, etc.) is determined by the EncodingMode property setting.

Returns null on failure

top
CompressBytesENCAsync (1)
Function ComCompressBytesENCAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
CompressEncryptFile
Function ComCompressEncryptFile cComChilkatJsonObject cryptParams String srcPath String destPath Returns Boolean
Introduced in version 9.5.0.99

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.

top
CompressEncryptFileAsync (1)
Function ComCompressEncryptFileAsync cComChilkatJsonObject cryptParams String srcPath String destPath Returns cComChilkatTask
Introduced in version 9.5.0.99

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

Returns null on failure

top
CompressFile
Function ComCompressFile String srcPath String destPath Returns Boolean

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 ComCompressFileAsync String srcPath String destPath Returns cComChilkatTask

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

Returns null on failure

top
CompressSb
Function ComCompressSb cComChilkatStringBuilder sb cComChilkatBinData binData Returns Boolean
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 ComCompressSbAsync cComChilkatStringBuilder sb cComChilkatBinData binData Returns cComChilkatTask
Introduced in version 9.5.0.73

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

Returns null on failure

top
CompressStream
Function ComCompressStream cComChilkatStream strm Returns Boolean
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 ComCompressStreamAsync cComChilkatStream strm Returns cComChilkatTask
Introduced in version 9.5.0.56

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

Returns null on failure

top
CompressString
Function ComCompressString String str Returns Variant

Compresses a string.

Returns null on failure

More Information and Examples
top
CompressStringAsync (1)
Function ComCompressStringAsync String str Returns cComChilkatTask

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

Returns null on failure

top
CompressStringENC
Function ComCompressStringENC String str Returns String

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 null on failure

More Information and Examples
top
CompressStringENCAsync (1)
Function ComCompressStringENCAsync String str Returns cComChilkatTask

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

Returns null on failure

top
DecompressBd
Function ComDecompressBd cComChilkatBinData binData Returns Boolean
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 ComDecompressBdAsync cComChilkatBinData binData Returns cComChilkatTask
Introduced in version 9.5.0.66

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

Returns null on failure

top
DecompressBytes
Function ComDecompressBytes Variant data Returns Variant

The opposite of CompressBytes.

Returns null on failure

More Information and Examples
top
DecompressBytesAsync (1)
Function ComDecompressBytesAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
DecompressBytesENC
Function ComDecompressBytesENC String encodedCompressedData Returns Variant

The opposite of CompressBytesENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting.

Returns null on failure

top
DecompressBytesENCAsync (1)
Function ComDecompressBytesENCAsync String encodedCompressedData Returns cComChilkatTask

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

Returns null on failure

top
DecompressFile
Function ComDecompressFile String srcPath String destPath Returns Boolean

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 ComDecompressFileAsync String srcPath String destPath Returns cComChilkatTask

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

Returns null on failure

top
DecompressSb
Function ComDecompressSb cComChilkatBinData binData cComChilkatStringBuilder sb Returns Boolean
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 ComDecompressSbAsync cComChilkatBinData binData cComChilkatStringBuilder sb Returns cComChilkatTask
Introduced in version 9.5.0.73

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

Returns null on failure

top
DecompressStream
Function ComDecompressStream cComChilkatStream strm Returns Boolean
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 ComDecompressStreamAsync cComChilkatStream strm Returns cComChilkatTask
Introduced in version 9.5.0.56

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

Returns null on failure

top
DecompressString
Function ComDecompressString Variant data Returns String

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

Returns null on failure

More Information and Examples
top
DecompressStringAsync (1)
Function ComDecompressStringAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
DecompressStringENC
Function ComDecompressStringENC String encodedCompressedData Returns String

The opposite of CompressStringENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting.

Returns null on failure

More Information and Examples
top
DecompressStringENCAsync (1)
Function ComDecompressStringENCAsync String encodedCompressedData Returns cComChilkatTask

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

Returns null on failure

top
DecryptDecompressFile
Function ComDecryptDecompressFile cComChilkatJsonObject cryptParams String srcPath String destPath Returns Boolean
Introduced in version 9.5.0.99

Performs file-to-file decryption and decompression.

Returns True for success, False for failure.

top
DecryptDecompressFileAsync (1)
Function ComDecryptDecompressFileAsync cComChilkatJsonObject cryptParams String srcPath String destPath Returns cComChilkatTask
Introduced in version 9.5.0.99

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

Returns null on failure

top
EndCompressBytes
Function ComEndCompressBytes Returns Variant

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytes)

Returns null on failure

More Information and Examples
top
EndCompressBytesAsync (1)
Function ComEndCompressBytesAsync Returns cComChilkatTask

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

Returns null on failure

top
EndCompressBytesENC
Function ComEndCompressBytesENC Returns String

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytesENC)

Returns null on failure

top
EndCompressBytesENCAsync (1)
Function ComEndCompressBytesENCAsync Returns cComChilkatTask

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

Returns null on failure

top
EndCompressString
Function ComEndCompressString Returns Variant

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressString)

Returns null on failure

More Information and Examples
top
EndCompressStringAsync (1)
Function ComEndCompressStringAsync Returns cComChilkatTask

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

Returns null on failure

top
EndCompressStringENC
Function ComEndCompressStringENC Returns String

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressStringENC)

Returns null on failure

More Information and Examples
top
EndCompressStringENCAsync (1)
Function ComEndCompressStringENCAsync Returns cComChilkatTask

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

Returns null on failure

top
EndDecompressBytes
Function ComEndDecompressBytes Returns Variant

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressBytes)

Returns null on failure

More Information and Examples
top
EndDecompressBytesAsync (1)
Function ComEndDecompressBytesAsync Returns cComChilkatTask

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

Returns null on failure

top
EndDecompressBytesENC
Function ComEndDecompressBytesENC Returns Variant

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 null on failure

top
EndDecompressBytesENCAsync (1)
Function ComEndDecompressBytesENCAsync Returns cComChilkatTask

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

Returns null on failure

top
EndDecompressString
Function ComEndDecompressString Returns String

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressString)

Returns null on failure

More Information and Examples
top
EndDecompressStringAsync (1)
Function ComEndDecompressStringAsync Returns cComChilkatTask

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

Returns null on failure

top
EndDecompressStringENC
Function ComEndDecompressStringENC Returns String

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 null on failure

top
EndDecompressStringENCAsync (1)
Function ComEndDecompressStringENCAsync Returns cComChilkatTask

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

Returns null on failure

top
LoadTaskCaller
Function ComLoadTaskCaller cComChilkatTask task Returns Boolean
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

top
MoreCompressBytes
Function ComMoreCompressBytes Variant data Returns Variant

(See BeginCompressBytes)

Returns null on failure

More Information and Examples
top
MoreCompressBytesAsync (1)
Function ComMoreCompressBytesAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
MoreCompressBytesENC
Function ComMoreCompressBytesENC Variant data Returns String

(See BeginCompressBytesENC)

Returns null on failure

top
MoreCompressBytesENCAsync (1)
Function ComMoreCompressBytesENCAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
MoreCompressString
Function ComMoreCompressString String str Returns Variant

(See BeginCompressString)

Returns null on failure

More Information and Examples
top
MoreCompressStringAsync (1)
Function ComMoreCompressStringAsync String str Returns cComChilkatTask

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

Returns null on failure

top
MoreCompressStringENC
Function ComMoreCompressStringENC String str Returns String

(See BeginCompressStringENC)

Returns null on failure

More Information and Examples
top
MoreCompressStringENCAsync (1)
Function ComMoreCompressStringENCAsync String str Returns cComChilkatTask

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

Returns null on failure

top
MoreDecompressBytes
Function ComMoreDecompressBytes Variant data Returns Variant

(See BeginDecompressBytes)

Returns null on failure

More Information and Examples
top
MoreDecompressBytesAsync (1)
Function ComMoreDecompressBytesAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
MoreDecompressBytesENC
Function ComMoreDecompressBytesENC String str Returns Variant

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 null on failure

top
MoreDecompressBytesENCAsync (1)
Function ComMoreDecompressBytesENCAsync String str Returns cComChilkatTask

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

Returns null on failure

top
MoreDecompressString
Function ComMoreDecompressString Variant data Returns String

(See BeginDecompressString)

Returns null on failure

More Information and Examples
top
MoreDecompressStringAsync (1)
Function ComMoreDecompressStringAsync Variant data Returns cComChilkatTask

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

Returns null on failure

top
MoreDecompressStringENC
Function ComMoreDecompressStringENC String str Returns String

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 null on failure

top
MoreDecompressStringENCAsync (1)
Function ComMoreDecompressStringENCAsync String str Returns cComChilkatTask

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

Returns null on failure

top