Chilkat VB.NET Compression Class Reference

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

(C#)
Chilkat.Compression obj = new Chilkat.Compression();
(VB.NET)
Dim obj As New Chilkat.Compression()

Properties

Algorithm As String

The compression algorithm to be used. Should be set to either "ppmd", "deflate", "bzip2", or "lzw".

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.

EnableEvents As Boolean

This property must be set to true to enable events. By default, it is false.

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.

LastErrorHtml As String (ReadOnly)

Error information in HTML format for the last method called.

LastErrorText As String (ReadOnly)

Error information in plain-text format for the last method called.

LastErrorXml As String (ReadOnly)

Error information in XML format for the last method called.

Version As String (ReadOnly)

A version string, such as "1.2.0"

Methods

Function BeginCompressBytes(ByVal data As Byte()) As Byte()

To be documented soon...

Function BeginCompressBytesENC(ByVal data As Byte()) As String

To be documented soon...

Function BeginCompressString(ByVal str As String) As Byte()

To be documented soon...

Function BeginCompressStringENC(ByVal str As String) As String

To be documented soon...

Function BeginDecompressBytes(ByVal data As Byte()) As Byte()

To be documented soon...

Function BeginDecompressBytesENC(ByVal str As String) As Byte()

To be documented soon.

Returns Nothing on failure

Function BeginDecompressString(ByVal data As Byte()) As String

To be documented soon...

Function BeginDecompressStringENC(ByVal str As String) As String

To be documented soon...

Function CompressBytes(ByVal data As Byte()) As Byte()

To be documented soon...

Function CompressBytesENC(ByVal data As Byte()) As String

To be documented soon...

Function CompressFile(ByVal inFile As String, ByVal outFile As String) As Boolean

To be documented soon...

Function CompressString(ByVal str As String) As Byte()

To be documented soon...

Function CompressStringENC(ByVal str As String) As String

To be documented soon...

Function DecompressBytes(ByVal data As Byte()) As Byte()

To be documented soon...

Function DecompressBytesENC(ByVal str As String) As Byte()

To be documented soon...

Function DecompressFile(ByVal inFile As String, ByVal outFile As String) As Boolean

To be documented soon...

Function DecompressString(ByVal data As Byte()) As String

To be documented soon...

Function DecompressStringENC(ByVal str As String) As String

To be documented soon...

Function EndCompressBytes() As Byte()

To be documented soon...

Function EndCompressBytesENC() As String

To be documented soon...

Function EndCompressString() As Byte()

To be documented soon...

Function EndCompressStringENC() As String

To be documented soon...

Function EndDecompressBytes() As Byte()

To be documented soon...

Function EndDecompressBytesENC() As Byte()

To be documented soon...

Function EndDecompressString() As String

To be documented soon...

Function EndDecompressStringENC() As String

To be documented soon...

Function MoreCompressBytes(ByVal data As Byte()) As Byte()

To be documented soon...

Function MoreCompressBytesENC(ByVal data As Byte()) As String

To be documented soon...

Function MoreCompressString(ByVal str As String) As Byte()

To be documented soon...

Function MoreCompressStringENC(ByVal str As String) As String

To be documented soon...

Function MoreDecompressBytes(ByVal data As Byte()) As Byte()

To be documented soon...

Function MoreDecompressBytesENC(ByVal str As String) As Byte()

To be documented soon...

Function MoreDecompressString(ByVal data As Byte()) As String

To be documented soon...

Function MoreDecompressStringENC(ByVal str As String) As String

To be documented soon...

Function SaveLastError(ByVal filename As String) As Boolean

Saves the last error information to an XML formatted file.

Function UnlockComponent(ByVal unlockCode As String) As Boolean

To be documented soon...