Chilkat.UnixCompress PHP ActiveX Reference

Chilkat.UnixCompress

UNIX (.Z) compression component.

Object Creation

$obj = new COM("Chilkat.UnixCompress");

Properties

string LastErrorHtml (read-only)

Error information in HTML format for the last method called.

string LastErrorText (read-only)

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

string LastErrorXml (read-only)

Error information in XML format for the last method called.

string Version (read-only)

To be documented soon...

Methods

bool CompressFile(string inFilename, string outFilename)

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

Returns 1 for success, 0 for failure.

VARIANT CompressFileToMem(string inFilename)

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

Returns 1 for success, 0 for failure.

bool CompressMemToFile(VARIANT inData, string outFilename)

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

Returns 1 for success, 0 for failure.

VARIANT CompressMemory(VARIANT inData)

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

Returns 1 for success, 0 for failure.

VARIANT CompressString(string inStr, string outCharset)

To be documented soon...

bool CompressStringToFile(string inStr, string outCharset, string outFilename)

To be documented soon...

bool IsUnlocked()

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

VARIANT ReadFile(string filename)

To be documented soon...

void SaveLastError(string filename)

Saves the last error information to an XML formatted file.

bool UnTarZ(string zFilename, string destDir, int noAbsolute)

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

bool UncompressFile(string inFilename, string outFilename)

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

Returns 1 for success, 0 for failure.

VARIANT UncompressFileToMem(string inFilename)

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

Returns 1 for success, 0 for failure.

string UncompressFileToString(string zFilename, string charset)

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

List of Valid Charsets

bool UncompressMemToFile(VARIANT inData, string outFilename)

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

Returns 1 for success, 0 for failure.

VARIANT UncompressMemory(VARIANT inData)

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

Returns 1 for success, 0 for failure.

string UncompressString(VARIANT inData, string inCharset)

To be documented soon...

bool UnlockComponent(string b1)

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

Returns 1 for success, 0 for failure.

bool WriteFile(string filename, VARIANT binaryData)

To be documented soon...