UnixCompress PHP ActiveX Reference Documentation

UnixCompress

Current Version: 10.1.2

Requires Chilkat Bundle License

UNIX (.Z) compression component.

Object Creation

Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.UnixCompress");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.UnixCompress");

Properties

AbortCurrent

bool AbortCurrent

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

DebugLogFilePath

string DebugLogFilePath

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastBinaryResult

VARIANT LastBinaryResult (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to true. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

string LastErrorHtml (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

string LastErrorText (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

string LastErrorXml (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

bool LastMethodSuccess

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

string LastStringResult (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

int LastStringResultLen (read-only)

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

VerboseLogging

bool VerboseLogging

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.

Version

string Version (read-only)

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressFile

bool CompressFile(string inFilename, string destPath)

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.

CompressFileAsync ⁽¹⁾

Chilkat.Task CompressFileAsync(string inFilename, string destPath)

Creates an asynchronous task to call the CompressFile method with the arguments provided.

Returns null on failure

CompressFileToMem

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

CompressFileToMemAsync ⁽¹⁾

Chilkat.Task CompressFileToMemAsync(string inFilename)

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided.

Returns null on failure

CompressMemory

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

CompressMemToFile

bool CompressMemToFile(VARIANT inData, string destPath)

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.

CompressString

VARIANT CompressString(string inStr, string charset)

Compresses a string to an in-memory image of a .Z file. Prior to compression, the string is converted to the character encoding specified by charset. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns null on failure

More Information and Examples

List of Valid Charsets

CompressStringToFile

bool CompressStringToFile(string inStr, string charset, string destPath)

Unix compresses and creates a .Z file from string data. The charset specifies the character encoding used for the byte representation of the characters when compressed. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns true for success, false for failure.

More Information and Examples

List of Valid Charsets

LoadTaskCaller

bool LoadTaskCaller(Chilkat.Task task)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

ReadFile

VARIANT ReadFile(string filename)

Convenience method to read an entire file and return as a byte array.

Returns null on failure

UncompressFile

bool UncompressFile(string inFilename, string destPath)

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

Returns true for success, false for failure.

UncompressFileAsync ⁽¹⁾

Chilkat.Task UncompressFileAsync(string inFilename, string destPath)

Creates an asynchronous task to call the UncompressFile method with the arguments provided.

Returns null on failure

UncompressFileToMem

VARIANT UncompressFileToMem(string inFilename)

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

Returns null on failure

UncompressFileToMemAsync ⁽¹⁾

Chilkat.Task UncompressFileToMemAsync(string inFilename)

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided.

Returns null on failure

UncompressFileToString

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

More Information and Examples

List of Valid Charsets

UncompressFileToStringAsync ⁽¹⁾

Chilkat.Task UncompressFileToStringAsync(string zFilename, string charset)

Creates an asynchronous task to call the UncompressFileToString method with the arguments provided.

Returns null on failure

UncompressMemory

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

UncompressMemToFile

bool UncompressMemToFile(VARIANT inData, string destPath)

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.

UncompressString

string UncompressString(VARIANT inCompressedData, string charset)

Uncompresses from an in-memory image of a .Z file directly to a string. The charset specifies the character encoding used to interpret the bytes resulting from the decompression. The charset can be any one of a large number of character encodings, such as "utf-8", "iso-8859-1", "Windows-1252", "ucs-2", etc.

Returns null on failure

More Information and Examples

List of Valid Charsets

UnTarZ

bool UnTarZ(string zFilename, string destDir, bool bNoAbsolute)

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.

UnTarZAsync ⁽¹⁾

Chilkat.Task UnTarZAsync(string zFilename, string destDir, bool bNoAbsolute)

Creates an asynchronous task to call the UnTarZ method with the arguments provided.

Returns null on failure

WriteFile

bool WriteFile(string filename, VARIANT binaryData)

Convenience method for writing the contents of a byte array to a file.

Returns true for success, false for failure.