Chilkat VB.NET UnixCompress Class Reference

UnixCompress

UNIX (.Z) compression component.

Object Creation

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

Properties

EnableEvents As Boolean

To be documented soon...

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.

Methods

Function CompressFile(ByVal inFilename As String, ByVal outFilename As String) As Boolean

Compresses a file to create a UNIX compressed file (.Z). This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.

Returns true for success, false for failure.

Function CompressFileToMem(ByVal inFilename As String) As Byte()

Unix compresses a file to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns a NULL object reference on failure.

Returns an empty byte array on failure

Function CompressMemToFile(ByVal inData As Byte(), ByVal outFilename As String) As Boolean

Unix compresses and creates a .Z file from in-memory data. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

Function CompressMemory(ByVal inData As Byte()) As Byte()

Compresses in-memory data to an in-memory image of a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns an empty byte array on failure

Function CompressString(ByVal inStr As String, ByVal outCharset As String) As Byte()

To be documented soon...

Function CompressStringToFile(ByVal inStr As String, ByVal outCharset As String, ByVal outFilename As String) As Boolean

To be documented soon...

Function IsUnlocked() As Boolean

Returns true if the component has been unlocked. (For ActiveX, returns 1 if unlocked.)

Function SaveLastError(ByVal filename As String) As Boolean

Saves the last error information to an XML formatted file.

Function UnTarZ(ByVal zFilename As String, ByVal destDir As String, ByVal bNoAbsolute As Boolean) As Boolean

Unpacks a .tar.Z file. The decompress and untar occur in streaming mode. There are no temporary files and the memory footprint is constant (and small) while untarring.

Returns true for success, false for failure.

Function UncompressFile(ByVal inFilename As String, ByVal outFilename As String) As Boolean

Uncompresses a .Z file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

Function UncompressFileToMem(ByVal inFilename As String) As Byte()

Uncompresses a .Z file directly to memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns a NULL object reference on failure.

Returns an empty byte array on failure

Function UncompressFileToString(ByVal zFilename As String, ByVal charset As String) As String

Uncompresses a .Z file that contains a text file. The contents of the text file are returned as a string. The character encoding of the text file is specified by charset. Typical charsets are "iso-8859-1", "utf-8", "windows-1252", "shift_JIS", "big5", etc.

Returns Nothing on failure

List of Valid Charsets

Function UncompressMemToFile(ByVal inData As Byte(), ByVal outFilename As String) As Boolean

Uncompresses from an in-memory image of a .Z file to a file. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns true for success, false for failure.

Function UncompressMemory(ByVal inData As Byte()) As Byte()

Uncompresses from an in-memory image of a .Z file directly into memory. (This compression uses the LZW (Lempel-Ziv-Welch) compression algorithm.)

Returns a NULL object reference on failure.

Returns an empty byte array on failure

Function UncompressString(ByVal inData As Byte(), ByVal inCharset As String) As String

To be documented soon...

Function UnlockComponent(ByVal unlockCode As String) As Boolean

Unlocks the component allowing for the full functionality to be used.

Returns true for success, false for failure.