UnixCompress Delphi DLL Reference Documentation

UnixCompress

Current Version: 9.5.0.73

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

top
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:

  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.

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

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

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

top
LastMethodSuccess
function CkUnixCompress_getLastMethodSuccess(objHandle: HCkUnixCompress): wordbool; stdcall;
procedure CkUnixCompress_putLastMethodSuccess(objHandle: HCkUnixCompress; newPropVal: wordbool); stdcall;
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.

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

top
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.63"

top

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.

top
CompressFileAsync (1)
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.)

Returns nil on failure

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

top
CompressFileToMemAsync (1)
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.)

Returns nil on failure

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

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

top
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
top
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
top
IsUnlocked
function CkUnixCompress_IsUnlocked(objHandle: HCkUnixCompress): wordbool; stdcall;

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

top
SaveLastError
function CkUnixCompress_SaveLastError(objHandle: HCkUnixCompress;
    path: PWideChar): wordbool; stdcall;

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns True for success, False for failure.

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

top
UncompressFileAsync (1)
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.)

Returns nil on failure

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

top
UncompressFileToMemAsync (1)
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.)

Returns nil on failure

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

More Information and Examples
top
UncompressFileToStringAsync (1)
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.)

Returns nil on failure

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

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

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

More Information and Examples
top
UnlockComponent
function CkUnixCompress_UnlockComponent(objHandle: HCkUnixCompress;
    unlockCode: PWideChar): wordbool; stdcall;

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

Returns True for success, False for failure.

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

top
UnTarZAsync (1)
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.)

Returns nil on failure

top