Compression ActiveX Reference Documentation

Compression

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

(Visual Basic 6.0)
Dim obj As New ChilkatCompression

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.Compression")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.Compression")

(Delphi)
obj := TChilkatCompression.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.Compression')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.Compression")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Compression', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Compression");

Properties

Algorithm As String

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.

Charset As String

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.

DebugLogFilePath As String

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.

EncodingMode As String

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.

HeartbeatMs As Long

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.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. 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).

LastErrorHtml As String (read-only)

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.

LastErrorText As String (read-only)

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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

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.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. 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).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version As String (read-only)

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

Methods

BeginCompressBytes(data As Variant) As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Large Binary File in Blocks

(Visual FoxPro) Compress Large Binary File in Blocks

(PowerBuilder) Compress Large Binary File in Blocks

(SQL Server) Compress Large Binary File in Blocks

(Visual Basic 6.0) Compress Large Binary File in Blocks

(VBScript) Compress Large Binary File in Blocks

BeginCompressBytesAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

BeginCompressBytesENC(data As Variant) As 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 Nothing on failure

BeginCompressBytesENCAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

BeginCompressString(str As String) As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Text Feed to Binary

(Visual FoxPro) Compress Text Feed to Binary

(PowerBuilder) Compress Text Feed to Binary

(SQL Server) Compress Text Feed to Binary

(Visual Basic 6.0) Compress Text Feed to Binary

(VBScript) Compress Text Feed to Binary

BeginCompressStringAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

BeginCompressStringENC(str As String) As 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 Nothing on failure

(Classic ASP) Compress String Feed to Base64

(Visual FoxPro) Compress String Feed to Base64

(PowerBuilder) Compress String Feed to Base64

(SQL Server) Compress String Feed to Base64

(Visual Basic 6.0) Compress String Feed to Base64

(VBScript) Compress String Feed to Base64

BeginCompressStringENCAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

BeginDecompressBytes(data As Variant) As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Decompress Large Binary File in Blocks

(Visual FoxPro) Decompress Large Binary File in Blocks

(PowerBuilder) Decompress Large Binary File in Blocks

(SQL Server) Decompress Large Binary File in Blocks

(Visual Basic 6.0) Decompress Large Binary File in Blocks

(VBScript) Decompress Large Binary File in Blocks

BeginDecompressBytesAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

BeginDecompressBytesENC(str As String) As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

BeginDecompressBytesENCAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

BeginDecompressString(data As Variant) As 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 Nothing on failure

(Classic ASP) Decompress Large Text File in Blocks

(Visual FoxPro) Decompress Large Text File in Blocks

(PowerBuilder) Decompress Large Text File in Blocks

(SQL Server) Decompress Large Text File in Blocks

(Visual Basic 6.0) Decompress Large Text File in Blocks

(VBScript) Decompress Large Text File in Blocks

BeginDecompressStringAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

BeginDecompressStringENC(str As String) As 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 Nothing on failure

BeginDecompressStringENCAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

CompressBd(binData As ChilkatBinData) As Long

Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns 1 for success, 0 for failure.

(Classic ASP) Compress and Decompress Base64

(Visual FoxPro) Compress and Decompress Base64

(PowerBuilder) Compress and Decompress Base64

(SQL Server) Compress and Decompress Base64

(Visual Basic 6.0) Compress and Decompress Base64

(VBScript) Compress and Decompress Base64

(Classic ASP) Compress and Decompress Hex String

(Visual FoxPro) Compress and Decompress Hex String

(PowerBuilder) Compress and Decompress Hex String

(SQL Server) Compress and Decompress Hex String

(Visual Basic 6.0) Compress and Decompress Hex String

(VBScript) Compress and Decompress Hex String

CompressBdAsync(binData As ChilkatBinData) As ChilkatTask

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.)

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

CompressBytes(data As Variant) As Variant

Compresses byte data.

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Bytes

(Visual FoxPro) Compress Bytes

(PowerBuilder) Compress Bytes

(SQL Server) Compress Bytes

(Visual Basic 6.0) Compress Bytes

(VBScript) Compress Bytes

CompressBytesAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

CompressBytesENC(data As Variant) As 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 Nothing on failure

(Classic ASP) Compress Bytes to Base64 (or any other encoding)

(Visual FoxPro) Compress Bytes to Base64 (or any other encoding)

(PowerBuilder) Compress Bytes to Base64 (or any other encoding)

(SQL Server) Compress Bytes to Base64 (or any other encoding)

(Visual Basic 6.0) Compress Bytes to Base64 (or any other encoding)

(VBScript) Compress Bytes to Base64 (or any other encoding)

CompressBytesENCAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

CompressFile(srcPath As String, destPath As String) As Long

Performs file-to-file compression. Files of any size may be compressed because the file is compressed internally in streaming mode.

Returns 1 for success, 0 for failure.

(Classic ASP) Compress and Decompress a File

(Visual FoxPro) Compress and Decompress a File

(PowerBuilder) Compress and Decompress a File

(SQL Server) Compress and Decompress a File

(Visual Basic 6.0) Compress and Decompress a File

(VBScript) Compress and Decompress a File

CompressFileAsync(srcPath As String, destPath As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

CompressStream(strm As ChilkatStream) As Long

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 1 for success, 0 for failure.

(Classic ASP) Streaming Compression

(Visual FoxPro) Streaming Compression

(PowerBuilder) Streaming Compression

(SQL Server) Streaming Compression

(Visual Basic 6.0) Streaming Compression

(VBScript) Streaming Compression

CompressStreamAsync(strm As ChilkatStream) As ChilkatTask

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.)

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

CompressString(str As String) As Variant

Compresses a string.

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress and Decompress a String

(Visual FoxPro) Compress and Decompress a String

(PowerBuilder) Compress and Decompress a String

(SQL Server) Compress and Decompress a String

(Visual Basic 6.0) Compress and Decompress a String

(VBScript) Compress and Decompress a String

CompressStringAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

CompressStringENC(str As String) As 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 Nothing on failure

(Classic ASP) Compress and Decompress a String

(Visual FoxPro) Compress and Decompress a String

(PowerBuilder) Compress and Decompress a String

(SQL Server) Compress and Decompress a String

(Visual Basic 6.0) Compress and Decompress a String

(VBScript) Compress and Decompress a String

CompressStringENCAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DecompressBd(binData As ChilkatBinData) As Long

Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns 1 for success, 0 for failure.

(Classic ASP) Compress and Decompress Base64

(Visual FoxPro) Compress and Decompress Base64

(PowerBuilder) Compress and Decompress Base64

(SQL Server) Compress and Decompress Base64

(Visual Basic 6.0) Compress and Decompress Base64

(VBScript) Compress and Decompress Base64

(Classic ASP) Compress and Decompress Hex String

(Visual FoxPro) Compress and Decompress Hex String

(PowerBuilder) Compress and Decompress Hex String

(SQL Server) Compress and Decompress Hex String

(Visual Basic 6.0) Compress and Decompress Hex String

(VBScript) Compress and Decompress Hex String

DecompressBdAsync(binData As ChilkatBinData) As ChilkatTask

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.)

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DecompressBytes(data As Variant) As Variant

The opposite of CompressBytes.

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Decompress Bytes

(Visual FoxPro) Decompress Bytes

(PowerBuilder) Decompress Bytes

(SQL Server) Decompress Bytes

(Visual Basic 6.0) Decompress Bytes

(VBScript) Decompress Bytes

DecompressBytesAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DecompressBytesENC(encodedCompressedData As String) As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Bytes to Base64 (or any other encoding)

(Visual FoxPro) Compress Bytes to Base64 (or any other encoding)

(PowerBuilder) Compress Bytes to Base64 (or any other encoding)

(SQL Server) Compress Bytes to Base64 (or any other encoding)

(Visual Basic 6.0) Compress Bytes to Base64 (or any other encoding)

(VBScript) Compress Bytes to Base64 (or any other encoding)

DecompressBytesENCAsync(encodedCompressedData As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DecompressFile(srcPath As String, destPath As String) As Long

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 1 for success, 0 for failure.

(Classic ASP) Compress and Decompress a File

(Visual FoxPro) Compress and Decompress a File

(PowerBuilder) Compress and Decompress a File

(SQL Server) Compress and Decompress a File

(Visual Basic 6.0) Compress and Decompress a File

(VBScript) Compress and Decompress a File

DecompressFileAsync(srcPath As String, destPath As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DecompressStream(strm As ChilkatStream) As Long

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 1 for success, 0 for failure.

(Classic ASP) Streaming Compression

(Visual FoxPro) Streaming Compression

(PowerBuilder) Streaming Compression

(SQL Server) Streaming Compression

(Visual Basic 6.0) Streaming Compression

(VBScript) Streaming Compression

DecompressStreamAsync(strm As ChilkatStream) As ChilkatTask

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.)

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DecompressString(data As Variant) As String

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

Returns Nothing on failure

(Classic ASP) Compress and Decompress a String

(Visual FoxPro) Compress and Decompress a String

(PowerBuilder) Compress and Decompress a String

(SQL Server) Compress and Decompress a String

(Visual Basic 6.0) Compress and Decompress a String

(VBScript) Compress and Decompress a String

DecompressStringAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

DecompressStringENC(encodedCompressedData As String) As 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 Nothing on failure

(Classic ASP) Compress and Decompress a String

(Visual FoxPro) Compress and Decompress a String

(PowerBuilder) Compress and Decompress a String

(SQL Server) Compress and Decompress a String

(Visual Basic 6.0) Compress and Decompress a String

(VBScript) Compress and Decompress a String

DecompressStringENCAsync(encodedCompressedData As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndCompressBytes() As Variant

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

(See BeginCompressBytes)

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Large Binary File in Blocks

(Visual FoxPro) Compress Large Binary File in Blocks

(PowerBuilder) Compress Large Binary File in Blocks

(SQL Server) Compress Large Binary File in Blocks

(Visual Basic 6.0) Compress Large Binary File in Blocks

(VBScript) Compress Large Binary File in Blocks

EndCompressBytesAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndCompressBytesENC() As String

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

(See BeginCompressBytesENC)

Returns Nothing on failure

EndCompressBytesENCAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndCompressString() As Variant

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

(See BeginCompressString)

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Text Feed to Binary

(Visual FoxPro) Compress Text Feed to Binary

(PowerBuilder) Compress Text Feed to Binary

(SQL Server) Compress Text Feed to Binary

(Visual Basic 6.0) Compress Text Feed to Binary

(VBScript) Compress Text Feed to Binary

EndCompressStringAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndCompressStringENC() As String

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

(See BeginCompressStringENC)

Returns Nothing on failure

(Classic ASP) Compress String Feed to Base64

(Visual FoxPro) Compress String Feed to Base64

(PowerBuilder) Compress String Feed to Base64

(SQL Server) Compress String Feed to Base64

(Visual Basic 6.0) Compress String Feed to Base64

(VBScript) Compress String Feed to Base64

EndCompressStringENCAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndDecompressBytes() As Variant

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

(See BeginDecompressBytes)

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Decompress Large Binary File in Blocks

(Visual FoxPro) Decompress Large Binary File in Blocks

(PowerBuilder) Decompress Large Binary File in Blocks

(SQL Server) Decompress Large Binary File in Blocks

(Visual Basic 6.0) Decompress Large Binary File in Blocks

(VBScript) Decompress Large Binary File in Blocks

EndDecompressBytesAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndDecompressBytesENC() As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

EndDecompressBytesENCAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndDecompressString() As String

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

(See BeginDecompressString)

Returns Nothing on failure

(Classic ASP) Decompress Large Text File in Blocks

(Visual FoxPro) Decompress Large Text File in Blocks

(PowerBuilder) Decompress Large Text File in Blocks

(SQL Server) Decompress Large Text File in Blocks

(Visual Basic 6.0) Decompress Large Text File in Blocks

(VBScript) Decompress Large Text File in Blocks

EndDecompressStringAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

EndDecompressStringENC() As 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 Nothing on failure

EndDecompressStringENCAsync() As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreCompressBytes(data As Variant) As Variant

(See BeginCompressBytes)

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Large Binary File in Blocks

(Visual FoxPro) Compress Large Binary File in Blocks

(PowerBuilder) Compress Large Binary File in Blocks

(SQL Server) Compress Large Binary File in Blocks

(Visual Basic 6.0) Compress Large Binary File in Blocks

(VBScript) Compress Large Binary File in Blocks

MoreCompressBytesAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreCompressBytesENC(data As Variant) As String

(See BeginCompressBytesENC)

Returns Nothing on failure

MoreCompressBytesENCAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreCompressString(str As String) As Variant

(See BeginCompressString)

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Compress Text Feed to Binary

(Visual FoxPro) Compress Text Feed to Binary

(PowerBuilder) Compress Text Feed to Binary

(SQL Server) Compress Text Feed to Binary

(Visual Basic 6.0) Compress Text Feed to Binary

(VBScript) Compress Text Feed to Binary

MoreCompressStringAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreCompressStringENC(str As String) As String

(See BeginCompressStringENC)

Returns Nothing on failure

(Classic ASP) Compress String Feed to Base64

(Visual FoxPro) Compress String Feed to Base64

(PowerBuilder) Compress String Feed to Base64

(SQL Server) Compress String Feed to Base64

(Visual Basic 6.0) Compress String Feed to Base64

(VBScript) Compress String Feed to Base64

MoreCompressStringENCAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreDecompressBytes(data As Variant) As Variant

(See BeginDecompressBytes)

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

(Classic ASP) Decompress Large Binary File in Blocks

(Visual FoxPro) Decompress Large Binary File in Blocks

(PowerBuilder) Decompress Large Binary File in Blocks

(SQL Server) Decompress Large Binary File in Blocks

(Visual Basic 6.0) Decompress Large Binary File in Blocks

(VBScript) Decompress Large Binary File in Blocks

MoreDecompressBytesAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreDecompressBytesENC(str As String) As 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 a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

MoreDecompressBytesENCAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreDecompressString(data As Variant) As String

(See BeginDecompressString)

Returns Nothing on failure

(Classic ASP) Decompress Large Text File in Blocks

(Visual FoxPro) Decompress Large Text File in Blocks

(PowerBuilder) Decompress Large Text File in Blocks

(SQL Server) Decompress Large Text File in Blocks

(Visual Basic 6.0) Decompress Large Text File in Blocks

(VBScript) Decompress Large Text File in Blocks

MoreDecompressStringAsync(data As Variant) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

MoreDecompressStringENC(str As String) As 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 Nothing on failure

MoreDecompressStringENCAsync(str As String) As ChilkatTask

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

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

UnlockComponent(unlockCode As String) As Long

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 1 for success, 0 for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

Events

AbortCheck(abort As Long)

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.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myCompression As ChilkatCompression

Private Sub myCompression_AbortCheck(abort As Long)

	'Insert application code here.

End Sub

BinaryData(data As Variant)

Binary data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myCompression As ChilkatCompression

Private Sub myCompression_BinaryData(data As Variant)

	'Insert application code here.

End Sub

PercentDone(ByVal pctDone As Long, abort As Long)

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.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myCompression As ChilkatCompression

Private Sub myCompression_PercentDone(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub

ProgressInfo(name As String, value As String)

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.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myCompression As ChilkatCompression

Private Sub myCompression_ProgressInfo(name As String, value As String)

	'Insert application code here.

End Sub

TextData(data As String)

Text data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myCompression As ChilkatCompression

Private Sub myCompression_TextData(data As String)

	'Insert application code here.

End Sub