UnixCompress Delphi DLL Reference Documentation

UnixCompress

Current Version: 10.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, 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:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes 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 number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any method call prior to completion. If HeartbeatMs is 0 (the default), no AbortCheck event callbacks will fire.

LastErrorHtml

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

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.

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

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

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;

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.

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 "9.5.0.94"

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. (Async methods are available starting in Chilkat v9.5.0.52.)

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

CompressFileToMem

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

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

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

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

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

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

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

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. (Async methods are available starting in Chilkat v9.5.0.52.)

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

UncompressFileToMem

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

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

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

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. (Async methods are available starting in Chilkat v9.5.0.52.)

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

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

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

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

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. (Async methods are available starting in Chilkat v9.5.0.52.)

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

Chilkat supports event callbacks for the Delphi DLL starting in version 9.5.0.82.

AbortCheck

function MyAbortCheck(): Integer; cdecl;

Introduced in version 9.5.0.82

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200. Return True to abort; return False to continue (not abort)

More Information and Examples

Delphi DLL AbortCheck Event Callback Example

PercentDone

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

Introduced in version 9.5.0.82

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

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

More Information and Examples

Delphi DLL PercentDone Event Callback Example

ProgressInfo

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

Introduced in version 9.5.0.82

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

More Information and Examples

Delphi DLL ProgressInfo Event Callback Example

TaskCompleted

procedure MyTaskCompleted(task: HCkTask) cdecl;

Introduced in version 9.5.0.82

Called in the background thread when an asynchronous task completes.

More Information and Examples

Delphi DLL TaskCompleted Event Callback Example

top