UnixCompress DataFlex Reference Documentation

UnixCompress

UNIX (.Z) compression component.

Object Creation

Handle hoUnixCompress
Get Create(RefClass(cComUnixCompress)) to hoUnixCompress

Properties

Function ComAbortCurrent Returns Boolean
Procedure Set ComAbortCurrent Boolean value

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.)

Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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.

Function ComLastBinaryResult Returns Variant

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

Function ComLastErrorHtml Returns String

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.

Function ComLastErrorText Returns String

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.

Function ComLastErrorXml Returns String

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.

Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

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.

Function ComLastStringResult Returns String

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

Function ComLastStringResultLen Returns Integer

Introduced in version 9.5.0.53

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

Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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.

Function ComVersion Returns String

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

Methods

Function ComCompressFile String inFilename String destPath Returns 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 ComCompressFileAsync String inFilename String destPath Returns cComChilkatTask

Creates an asynchronous task to call the CompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run an Asynchronous Task

Function ComCompressFileToMem String inFilename Returns Variant

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

Returns True for success, False for failure.

Function ComCompressFileToMemAsync String inFilename Returns cComChilkatTask

Creates an asynchronous task to call the CompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run an Asynchronous Task

Function ComCompressMemToFile Variant inData String destPath Returns 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 ComCompressMemory Variant inData Returns Variant

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

Returns True for success, False for failure.

Function ComCompressString String inStr String charset Returns Variant

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 True for success, False for failure.

List of Valid Charsets

Function ComCompressStringToFile String inStr String charset String destPath Returns Boolean

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.

List of Valid Charsets

Function ComIsUnlocked Returns Boolean

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

Function ComReadFile Returns Variant

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

Returns null on failure

Function ComUnTarZ String zFilename String destDir Boolean bNoAbsolute Returns 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 ComUnTarZAsync String zFilename String destDir Boolean bNoAbsolute Returns cComChilkatTask

Creates an asynchronous task to call the UnTarZ method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run an Asynchronous Task

Function ComUncompressFile String inFilename String destPath Returns Boolean

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

Returns True for success, False for failure.

Function ComUncompressFileAsync String inFilename String destPath Returns cComChilkatTask

Creates an asynchronous task to call the UncompressFile method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run an Asynchronous Task

Function ComUncompressFileToMem String inFilename Returns Variant

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

Returns True for success, False for failure.

Function ComUncompressFileToMemAsync String inFilename Returns cComChilkatTask

Creates an asynchronous task to call the UncompressFileToMem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run an Asynchronous Task

Function ComUncompressFileToString String zFilename String charset Returns 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 True for success, False for failure.

List of Valid Charsets

Function ComUncompressFileToStringAsync String zFilename String charset Returns cComChilkatTask

Creates an asynchronous task to call the UncompressFileToString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run an Asynchronous Task

Function ComUncompressMemToFile Variant inData String destPath Returns 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 ComUncompressMemory Variant inData Returns Variant

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

Returns True for success, False for failure.

Function ComUncompressString Variant inCompressedData String charset Returns String

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 True for success, False for failure.

List of Valid Charsets

Function ComUnlockComponent String unlockCode Returns Boolean

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

Returns True for success, False for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

Function ComWriteFile Returns Boolean

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

Returns True for success, False for failure.