Compression C# Reference Documentation

Compression

Current Version: 9.5.0.73

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

Chilkat.Compression obj = new Chilkat.Compression();

Properties

Algorithm
public string Algorithm {get; set; }

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
public string Charset {get; set; }

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
public string DebugLogFilePath {get; set; }

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

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

top
DeflateLevel
public int DeflateLevel {get; set; }
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
public string EncodingMode {get; set; }

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
HeartbeatMs
public int HeartbeatMs {get; set; }

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.

top
LastErrorHtml
public string LastErrorHtml {get; }

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
public string LastErrorText {get; }

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
public string LastErrorXml {get; }

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
public bool LastMethodSuccess {get; set; }
Introduced in version 9.5.0.52

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

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

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

top
VerboseLogging
public bool VerboseLogging {get; set; }

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
public string Version {get; }

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

top

Methods

BeginCompressBytes
public byte[] BeginCompressBytes(byte[] data);

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 an empty byte array on failure

top
BeginCompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginCompressBytesAsync(byte[] data);

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

top
BeginCompressBytesENC
public string BeginCompressBytesENC(byte[] data);

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 (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginCompressBytesENCAsync(byte[] data);

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

top
BeginCompressString
public byte[] BeginCompressString(string str);

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 an empty byte array on failure

top
BeginCompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginCompressStringAsync(string str);

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

top
BeginCompressStringENC
public string BeginCompressStringENC(string str);

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

top
BeginCompressStringENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginCompressStringENCAsync(string str);

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

top
BeginDecompressBytes
public byte[] BeginDecompressBytes(byte[] data);

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 an empty byte array on failure

top
BeginDecompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginDecompressBytesAsync(byte[] data);

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

top
BeginDecompressBytesENC
public byte[] BeginDecompressBytesENC(string str);

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 an empty byte array on failure

top
BeginDecompressBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginDecompressBytesENCAsync(string str);

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

top
BeginDecompressString
public string BeginDecompressString(byte[] data);

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

top
BeginDecompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginDecompressStringAsync(byte[] data);

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

top
BeginDecompressStringENC
public string BeginDecompressStringENC(string str);

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 (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task BeginDecompressStringENCAsync(string str);

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

top
CompressBd
public bool CompressBd(BinData binData);
Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns true for success, false for failure.

top
CompressBdAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressBdAsync(BinData binData);
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 null on failure

top
CompressBytes
public byte[] CompressBytes(byte[] data);

Compresses byte data.

Returns an empty byte array on failure

top
CompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressBytesAsync(byte[] data);

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

top
CompressBytesENC
public string CompressBytesENC(byte[] data);

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 (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressBytesENCAsync(byte[] data);

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

top
CompressFile
public bool CompressFile(string srcPath, string destPath);

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.

top
CompressFileAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressFileAsync(string srcPath, string destPath);

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

top
CompressSb
public bool CompressSb(StringBuilder sb, BinData binData);
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 (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressSbAsync(StringBuilder sb, BinData binData);
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.)

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

top
CompressStream
public bool CompressStream(Stream strm);
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.

top
CompressStreamAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressStreamAsync(Stream strm);
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 null on failure

top
CompressString
public byte[] CompressString(string str);

Compresses a string.

Returns an empty byte array on failure

top
CompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressStringAsync(string str);

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

top
CompressStringENC
public string CompressStringENC(string str);

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

top
CompressStringENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task CompressStringENCAsync(string str);

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

top
DecompressBd
public bool DecompressBd(BinData binData);
Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns true for success, false for failure.

top
DecompressBdAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressBdAsync(BinData binData);
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 null on failure

top
DecompressBytes
public byte[] DecompressBytes(byte[] data);

The opposite of CompressBytes.

Returns an empty byte array on failure

top
DecompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressBytesAsync(byte[] data);

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

top
DecompressBytesENC
public byte[] DecompressBytesENC(string encodedCompressedData);

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

Returns an empty byte array on failure

top
DecompressBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressBytesENCAsync(string encodedCompressedData);

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

top
DecompressFile
public bool DecompressFile(string srcPath, string destPath);

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.

top
DecompressFileAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressFileAsync(string srcPath, string destPath);

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

top
DecompressSb
public bool DecompressSb(BinData binData, StringBuilder sb);
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 (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressSbAsync(BinData binData, StringBuilder sb);
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.)

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

top
DecompressStream
public bool DecompressStream(Stream strm);
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.

top
DecompressStreamAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressStreamAsync(Stream strm);
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 null on failure

top
DecompressString
public string DecompressString(byte[] data);

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

Returns null on failure

top
DecompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressStringAsync(byte[] data);

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

top
DecompressStringENC
public string DecompressStringENC(string encodedCompressedData);

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

top
DecompressStringENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task DecompressStringENCAsync(string encodedCompressedData);

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

top
EndCompressBytes
public byte[] EndCompressBytes();

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

(See BeginCompressBytes)

Returns an empty byte array on failure

top
EndCompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndCompressBytesAsync();

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

top
EndCompressBytesENC
public string EndCompressBytesENC();

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

(See BeginCompressBytesENC)

Returns null on failure

top
EndCompressBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndCompressBytesENCAsync();

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

top
EndCompressString
public byte[] EndCompressString();

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

(See BeginCompressString)

Returns an empty byte array on failure

top
EndCompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndCompressStringAsync();

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

top
EndCompressStringENC
public string EndCompressStringENC();

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

(See BeginCompressStringENC)

Returns null on failure

top
EndCompressStringENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndCompressStringENCAsync();

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

top
EndDecompressBytes
public byte[] EndDecompressBytes();

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

(See BeginDecompressBytes)

Returns an empty byte array on failure

top
EndDecompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndDecompressBytesAsync();

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

top
EndDecompressBytesENC
public byte[] EndDecompressBytesENC();

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 an empty byte array on failure

top
EndDecompressBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndDecompressBytesENCAsync();

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

top
EndDecompressString
public string EndDecompressString();

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

(See BeginDecompressString)

Returns null on failure

top
EndDecompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndDecompressStringAsync();

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

top
EndDecompressStringENC
public string EndDecompressStringENC();

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 (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task EndDecompressStringENCAsync();

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

top
MoreCompressBytes
public byte[] MoreCompressBytes(byte[] data);

(See BeginCompressBytes)

Returns an empty byte array on failure

top
MoreCompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreCompressBytesAsync(byte[] data);

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

top
MoreCompressBytesENC
public string MoreCompressBytesENC(byte[] data);

(See BeginCompressBytesENC)

Returns null on failure

top
MoreCompressBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreCompressBytesENCAsync(byte[] data);

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

top
MoreCompressString
public byte[] MoreCompressString(string str);

(See BeginCompressString)

Returns an empty byte array on failure

top
MoreCompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreCompressStringAsync(string str);

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

top
MoreCompressStringENC
public string MoreCompressStringENC(string str);

(See BeginCompressStringENC)

Returns null on failure

top
MoreCompressStringENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreCompressStringENCAsync(string str);

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

top
MoreDecompressBytes
public byte[] MoreDecompressBytes(byte[] data);

(See BeginDecompressBytes)

Returns an empty byte array on failure

top
MoreDecompressBytesAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreDecompressBytesAsync(byte[] data);

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

top
MoreDecompressBytesENC
public byte[] MoreDecompressBytesENC(string str);

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 an empty byte array on failure

top
MoreDecompressBytesENCAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreDecompressBytesENCAsync(string str);

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

top
MoreDecompressString
public string MoreDecompressString(byte[] data);

(See BeginDecompressString)

Returns null on failure

top
MoreDecompressStringAsync (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreDecompressStringAsync(byte[] data);

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

top
MoreDecompressStringENC
public string MoreDecompressStringENC(string str);

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 (C#) (Mono C#) (.NET Core C#) (PowerShell)
public Task MoreDecompressStringENCAsync(string str);

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

top
SaveLastError
public bool SaveLastError(string path);

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

Returns true for success, false for failure.

top
UnlockComponent
public bool UnlockComponent(string unlockCode);

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

Returns true for success, false for failure.

top

Events

AbortCheck
public event AbortCheckEventHandler OnAbortCheck;

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.

Chilkat .NET Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void compression_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
compression.OnAbortCheck += compression_OnAbortCheck;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
// ...
Chilkat.Compression.AbortCheck abortCheck = new Chilkat.Compression.AbortCheck(handleAbortCheck);
compression.setAbortCheckCb(abortCheck);
top
PercentDone
public event PercentDoneEventHandler OnPercentDone;

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 true will cause the method to abort and return a failed status (or whatever return value indicates failure).

Chilkat .NET Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void compression_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
compression.OnPercentDone += compression_OnPercentDone;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
// ...
Chilkat.Compression.PercentDone percentDone = new Chilkat.Compression.PercentDone(handlePercentDone);
compression.setPercentDoneCb(percentDone);
top
ProgressInfo
public event ProgressInfoEventHandler OnProgressInfo;

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.

Chilkat .NET Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void compression_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
compression.OnProgressInfo += compression_OnProgressInfo;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
// ...
Chilkat.Compression.ProgressInfo progressInfo = new Chilkat.Compression.ProgressInfo(handleProgressInfo);
compression.setProgressInfoCb(progressInfo);
top
TaskCompleted
public event TaskCompletedEventHandler OnTaskCompleted;

Called in the background thread when an asynchronous task completes.

More Information and Examples

Chilkat .NET Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void compression_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
compression.OnTaskCompleted += compression_OnTaskCompleted;

Chilkat Mono/.NET Core Event Implementation

Event callback implementation:

private void ENTRY_NAMEEventHandler OnENTRY_NAME
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Compression compression = new Chilkat.Compression();
// ...
Chilkat.Compression.TaskIdCompleted taskIdCompleted = new Chilkat.Compression.TaskIdCompleted(handleTaskIdCompleted);
compression.setTaskIdCompletedCb(taskIdCompleted);
top