UnixCompress Lianja Reference Documentation

UnixCompress

Current Version: 10.1.2

UNIX (.Z) compression component.

Object Creation

loObject = createobject("CkUnixCompress")

Properties

AbortCurrent
AbortCurrent As Boolean
Introduced in version 9.5.0.58

When set to .T., 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 .F. when the next method is called. When the abort occurs, this property is reset to .F.. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
DebugLogFilePath
DebugLogFilePath As Character

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
top
LastErrorHtml
LastErrorHtml As Character (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.

top
LastErrorText
LastErrorText As Character (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.

top
LastErrorXml
LastErrorXml As Character (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.

top
LastMethodSuccess
LastMethodSuccess As Boolean

Indicates the success or failure of the most recent method call: .T. means success, .F. 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.

top
VerboseLogging
VerboseLogging As Boolean

If set to .T., then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is .F.. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
Version As Character (read-only)

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

More Information and Examples
top

Methods

CompressFile
CompressFile(inFilename As Character, destPath As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
CompressFileAsync (1)
CompressFileAsync(inFilename As Character, destPath As Character) As CkTask

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

Returns .F. on failure

top
CompressStringToFile
CompressStringToFile(inStr As Character, charset As Character, destPath As Character) As 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 .T. for success, .F. for failure.

More Information and Examples
top
LoadTaskCaller
LoadTaskCaller(task As CkTask) As Boolean
Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns .T. for success, .F. for failure.

top
UncompressFile
UncompressFile(inFilename As Character, destPath As Character) As Boolean

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

Returns .T. for success, .F. for failure.

top
UncompressFileAsync (1)
UncompressFileAsync(inFilename As Character, destPath As Character) As CkTask

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

Returns .F. on failure

top
UncompressFileToString
UncompressFileToString(zFilename As Character, charset As Character) As Character

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 .F. on failure

More Information and Examples
top
UncompressFileToStringAsync (1)
UncompressFileToStringAsync(zFilename As Character, charset As Character) As CkTask

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

Returns .F. on failure

top
UnTarZ
UnTarZ(zFilename As Character, destDir As Character, 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 .T. for success, .F. for failure.

top
UnTarZAsync (1)
UnTarZAsync(zFilename As Character, destDir As Character, bNoAbsolute As Boolean) As CkTask

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

Returns .F. on failure

top