UnixCompress Delphi DLL Reference Documentation

UnixCompress

Current Version: 11.1.0

Requires Chilkat Bundle License

UNIX (.Z) compression component.

Create/Dispose

var
myObject: HCkUnixCompress;

begin
myObject := CkUnixCompress_Create();

// ...

CkUnixCompress_Dispose(myObject);
end;

function CkUnixCompress_Create: HCkUnixCompress; stdcall;

Creates an instance of the HCkUnixCompress object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkUnixCompress_Dispose(handle: HCkUnixCompress); stdcall;

Objects created by calling CkUnixCompress_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

AbortCurrent

function CkUnixCompress_getAbortCurrent(objHandle: HCkUnixCompress): wordbool; stdcall;
procedure CkUnixCompress_putAbortCurrent(objHandle: HCkUnixCompress; newPropVal: wordbool); stdcall;

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

procedure CkUnixCompress_getDebugLogFilePath(objHandle: HCkUnixCompress; outPropVal: HCkString); stdcall;
procedure CkUnixCompress_putDebugLogFilePath(objHandle: HCkUnixCompress; newPropVal: PWideChar); stdcall;
function CkUnixCompress__debugLogFilePath(objHandle: HCkUnixCompress): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

HeartbeatMs

function CkUnixCompress_getHeartbeatMs(objHandle: HCkUnixCompress): Integer; stdcall;
procedure CkUnixCompress_putHeartbeatMs(objHandle: HCkUnixCompress; newPropVal: Integer); stdcall;

The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.

More Information and Examples

Event Callback Examples

LastErrorHtml

procedure CkUnixCompress_getLastErrorHtml(objHandle: HCkUnixCompress; outPropVal: HCkString); stdcall;
function CkUnixCompress__lastErrorHtml(objHandle: HCkUnixCompress): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkUnixCompress_getLastErrorText(objHandle: HCkUnixCompress; outPropVal: HCkString); stdcall;
function CkUnixCompress__lastErrorText(objHandle: HCkUnixCompress): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkUnixCompress_getLastErrorXml(objHandle: HCkUnixCompress; outPropVal: HCkString); stdcall;
function CkUnixCompress__lastErrorXml(objHandle: HCkUnixCompress): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkUnixCompress_getLastMethodSuccess(objHandle: HCkUnixCompress): wordbool; stdcall;
procedure CkUnixCompress_putLastMethodSuccess(objHandle: HCkUnixCompress; newPropVal: wordbool); stdcall;

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.

VerboseLogging

function CkUnixCompress_getVerboseLogging(objHandle: HCkUnixCompress): wordbool; stdcall;
procedure CkUnixCompress_putVerboseLogging(objHandle: HCkUnixCompress; newPropVal: wordbool); stdcall;

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

procedure CkUnixCompress_getVersion(objHandle: HCkUnixCompress; outPropVal: HCkString); stdcall;
function CkUnixCompress__version(objHandle: HCkUnixCompress): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressFile

function CkUnixCompress_CompressFile(objHandle: HCkUnixCompress;
inFilename: PWideChar;
destPath: PWideChar): wordbool; stdcall;

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 ⁽¹⁾

function CkUnixCompress_CompressFileAsync(objHandle: HCkUnixCompress;
inFilename: PWideChar;
destPath: PWideChar): HCkTask; stdcall;

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

CompressStringToFile

function CkUnixCompress_CompressStringToFile(objHandle: HCkUnixCompress;
    inStr: PWideChar;
    charset: PWideChar;
    destPath: PWideChar): wordbool; stdcall;

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

function CkUnixCompress_LoadTaskCaller(objHandle: HCkUnixCompress;
task: HCkTask): wordbool; stdcall;

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns True for success, False for failure.

UncompressFile

function CkUnixCompress_UncompressFile(objHandle: HCkUnixCompress;
inFilename: PWideChar;
destPath: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

UncompressFileAsync ⁽¹⁾

function CkUnixCompress_UncompressFileAsync(objHandle: HCkUnixCompress;
inFilename: PWideChar;
destPath: PWideChar): HCkTask; stdcall;

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

UncompressFileToString

function CkUnixCompress_UncompressFileToString(objHandle: HCkUnixCompress;
    zFilename: PWideChar;
    charset: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkUnixCompress__uncompressFileToString(objHandle: HCkUnixCompress;
    zFilename: PWideChar;
    charset: PWideChar): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

List of Valid Charsets

UncompressFileToStringAsync ⁽¹⁾

function CkUnixCompress_UncompressFileToStringAsync(objHandle: HCkUnixCompress;
zFilename: PWideChar;
charset: PWideChar): HCkTask; stdcall;

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

UnTarZ

function CkUnixCompress_UnTarZ(objHandle: HCkUnixCompress;
    zFilename: PWideChar;
    destDir: PWideChar;
    bNoAbsolute: wordbool): wordbool; stdcall;

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 ⁽¹⁾

function CkUnixCompress_UnTarZAsync(objHandle: HCkUnixCompress;
    zFilename: PWideChar;
    destDir: PWideChar;
    bNoAbsolute: wordbool): HCkTask; stdcall;

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Events

AbortCheck

function MyAbortCheck(): Integer; cdecl;

Introduced in version 9.5.0.82

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second. Return True to abort; return False to continue (not abort)

More Information and Examples

Chilkat Event Callback Examples

PercentDone

function MyPercentDone(pctDone: Integer): Integer; cdecl;

Introduced in version 9.5.0.82

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

Return True to abort; return False to continue (not abort)

More Information and Examples

Chilkat Event Callback Examples

ProgressInfo

procedure MyProgressInfo(name: PWideChar; value: PWideChar) cdecl;

Introduced in version 9.5.0.82

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

More Information and Examples

Chilkat Event Callback Examples

TaskCompleted

procedure MyTaskCompleted(task: HCkTask) cdecl;

Introduced in version 9.5.0.82

Called from the background thread when an asynchronous task completes.

More Information and Examples

Delphi DLL TaskCompleted Event Callback Example

Deprecated

CompressFileToMem Deprecated

function CkUnixCompress_CompressFileToMem(objHandle: HCkUnixCompress;
inFilename: PWideChar;
outData: HCkByteData): wordbool; stdcall;

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.

CompressFileToMemAsync Deprecated ⁽¹⁾

function CkUnixCompress_CompressFileToMemAsync(objHandle: HCkUnixCompress;
inFilename: PWideChar): HCkTask; stdcall;

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

CompressMemory Deprecated

function CkUnixCompress_CompressMemory(objHandle: HCkUnixCompress;
inData: HCkByteData;
outData: HCkByteData): wordbool; stdcall;

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.

CompressMemToFile Deprecated

function CkUnixCompress_CompressMemToFile(objHandle: HCkUnixCompress;
inData: HCkByteData;
destPath: PWideChar): wordbool; stdcall;

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 Deprecated

function CkUnixCompress_CompressString(objHandle: HCkUnixCompress;
    inStr: PWideChar;
    charset: PWideChar;
    outBytes: HCkByteData): wordbool; stdcall;

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.

More Information and Examples

List of Valid Charsets

UncompressFileToMem Deprecated

function CkUnixCompress_UncompressFileToMem(objHandle: HCkUnixCompress;
inFilename: PWideChar;
outData: HCkByteData): wordbool; stdcall;

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

Returns True for success, False for failure.

UncompressFileToMemAsync Deprecated ⁽¹⁾

function CkUnixCompress_UncompressFileToMemAsync(objHandle: HCkUnixCompress;
inFilename: PWideChar): HCkTask; stdcall;

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

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

UncompressMemory Deprecated

function CkUnixCompress_UncompressMemory(objHandle: HCkUnixCompress;
inData: HCkByteData;
outData: HCkByteData): wordbool; stdcall;

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.

UncompressMemToFile Deprecated

function CkUnixCompress_UncompressMemToFile(objHandle: HCkUnixCompress;
inData: HCkByteData;
destPath: PWideChar): wordbool; stdcall;

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 Deprecated

function CkUnixCompress_UncompressString(objHandle: HCkUnixCompress;
    inCompressedData: HCkByteData;
    charset: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkUnixCompress__uncompressString(objHandle: HCkUnixCompress;
    inCompressedData: HCkByteData;
    charset: PWideChar): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

List of Valid Charsets