UnixCompress PureBasic Reference Documentation

UnixCompress

Current Version: 10.1.2

Requires Chilkat Bundle License

UNIX (.Z) compression component.

Object Creation

obj.i = CkUnixCompress::ckCreate()

; Make sure to dispose of the object when finished like this:
CkUnixCompress::ckDispose(obj);

Properties

AbortCurrent

Declare.i ckAbortCurrent(obj.i)
Declare setCkAbortCurrent(obj.i, value.i)

Introduced in version 9.5.0.58

When set to 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. 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

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

LastErrorHtml

Declare.s ckLastErrorHtml(obj.i) ; (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

Declare.s ckLastErrorText(obj.i) ; (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

Declare.s ckLastErrorXml(obj.i) ; (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

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

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

VerboseLogging

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

Version

Declare.s ckVersion(obj.i) ; (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

Declare.i ckCompressFile(obj.i, inFilename.s, destPath.s)

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.

CompressFileAsync ⁽¹⁾

Declare.i ckCompressFileAsync(obj.i, inFilename.s, destPath.s)

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

Returns 0 on failure

CompressStringToFile

Declare.i ckCompressStringToFile(obj.i, inStr.s, charset.s, destPath.s)

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

More Information and Examples

List of Valid Charsets

LoadTaskCaller

Declare.i ckLoadTaskCaller(obj.i, task.i)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

UncompressFile

Declare.i ckUncompressFile(obj.i, inFilename.s, destPath.s)

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

Returns 1 for success, 0 for failure.

UncompressFileAsync ⁽¹⁾

Declare.i ckUncompressFileAsync(obj.i, inFilename.s, destPath.s)

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

Returns 0 on failure

UncompressFileToString

Declare.s ckUncompressFileToString(obj.i, zFilename.s, charset.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples

List of Valid Charsets

UncompressFileToStringAsync ⁽¹⁾

Declare.i ckUncompressFileToStringAsync(obj.i, zFilename.s, charset.s)

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

Returns 0 on failure

UnTarZ

Declare.i ckUnTarZ(obj.i, zFilename.s, destDir.s, bNoAbsolute.l)

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.

UnTarZAsync ⁽¹⁾

Declare.i ckUnTarZAsync(obj.i, zFilename.s, destDir.s, bNoAbsolute.l)

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

Returns 0 on failure