UnixCompress Unicode C Reference Documentation

UnixCompress

Current Version: 9.5.0.75

UNIX (.Z) compression component.

Create/Dispose

HCkUnixCompressW instance = CkUnixCompressW_Create();
// ...
CkUnixCompressW_Dispose(instance);
HCkUnixCompressW CkUnixCompressW_Create(void);

Creates an instance of the HCkUnixCompressW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkUnixCompressW_Dispose(HCkUnixCompressW handle);

Objects created by calling CkUnixCompressW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkUnixCompressW_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkUnixCompressW_setAbortCheck(HCkUnixCompressW cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkUnixCompressW_setPercentDone(HCkUnixCompressW cHandle, BOOL (*fnPercentDone)(int pctDone));

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 callback is only called 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 methods 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).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkUnixCompressW_setProgressInfo(HCkUnixCompressW cHandle, void (*fnProgressInfo)(const wchar_t *name, const wchar_t *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkUnixCompressW_setTaskCompleted(HCkUnixCompressW cHandle, void (*fnTaskCompleted)(HCkTaskW hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)

Properties

AbortCurrent
BOOL CkUnixCompressW_getAbortCurrent(HCkUnixCompressW cHandle);
void CkUnixCompressW_putAbortCurrent(HCkUnixCompressW cHandle, BOOL newVal);
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
void CkUnixCompressW_getDebugLogFilePath(HCkUnixCompressW cHandle, HCkString retval);
void CkUnixCompressW_putDebugLogFilePath(HCkUnixCompressW cHandle, const wchar_t *newVal);
const wchar_t *CkUnixCompressW_debugLogFilePath(HCkUnixCompressW cHandle);

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
HeartbeatMs
int CkUnixCompressW_getHeartbeatMs(HCkUnixCompressW cHandle);
void CkUnixCompressW_putHeartbeatMs(HCkUnixCompressW cHandle, int newVal);

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.

top
LastErrorHtml
void CkUnixCompressW_getLastErrorHtml(HCkUnixCompressW cHandle, HCkString retval);
const wchar_t *CkUnixCompressW_lastErrorHtml(HCkUnixCompressW cHandle);

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
void CkUnixCompressW_getLastErrorText(HCkUnixCompressW cHandle, HCkString retval);
const wchar_t *CkUnixCompressW_lastErrorText(HCkUnixCompressW cHandle);

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
void CkUnixCompressW_getLastErrorXml(HCkUnixCompressW cHandle, HCkString retval);
const wchar_t *CkUnixCompressW_lastErrorXml(HCkUnixCompressW cHandle);

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
BOOL CkUnixCompressW_getLastMethodSuccess(HCkUnixCompressW cHandle);
void CkUnixCompressW_putLastMethodSuccess(HCkUnixCompressW cHandle, BOOL newVal);
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
BOOL CkUnixCompressW_getVerboseLogging(HCkUnixCompressW cHandle);
void CkUnixCompressW_putVerboseLogging(HCkUnixCompressW cHandle, BOOL newVal);

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
void CkUnixCompressW_getVersion(HCkUnixCompressW cHandle, HCkString retval);
const wchar_t *CkUnixCompressW_version(HCkUnixCompressW cHandle);

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

top

Methods

CompressFile
BOOL CkUnixCompressW_CompressFile(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);

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)
HCkTaskW CkUnixCompressW_CompressFileAsync(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);

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 NULL on failure

top
CompressFileToMem
BOOL CkUnixCompressW_CompressFileToMem(HCkUnixCompressW cHandle, const wchar_t *inFilename, const unsigned char * outData);

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)
HCkTaskW CkUnixCompressW_CompressFileToMemAsync(HCkUnixCompressW cHandle, const wchar_t *inFilename);

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 NULL on failure

top
CompressMemory
BOOL CkUnixCompressW_CompressMemory(HCkUnixCompressW cHandle, const unsigned char * inData, const unsigned char * outData);

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
BOOL CkUnixCompressW_CompressMemToFile(HCkUnixCompressW cHandle, const unsigned char * inData, const wchar_t *destPath);

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
BOOL CkUnixCompressW_CompressString(HCkUnixCompressW cHandle, const wchar_t *inStr, const wchar_t *charset, const unsigned char * outBytes);

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
BOOL CkUnixCompressW_CompressStringToFile(HCkUnixCompressW cHandle, const wchar_t *inStr, const wchar_t *charset, const wchar_t *destPath);

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
BOOL CkUnixCompressW_IsUnlocked(HCkUnixCompressW cHandle);

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

top
SaveLastError
BOOL CkUnixCompressW_SaveLastError(HCkUnixCompressW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

top
UncompressFile
BOOL CkUnixCompressW_UncompressFile(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);

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

Returns TRUE for success, FALSE for failure.

top
UncompressFileAsync (1)
HCkTaskW CkUnixCompressW_UncompressFileAsync(HCkUnixCompressW cHandle, const wchar_t *inFilename, const wchar_t *destPath);

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 NULL on failure

top
UncompressFileToMem
BOOL CkUnixCompressW_UncompressFileToMem(HCkUnixCompressW cHandle, const wchar_t *inFilename, const unsigned char * outData);

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)
HCkTaskW CkUnixCompressW_UncompressFileToMemAsync(HCkUnixCompressW cHandle, const wchar_t *inFilename);

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 NULL on failure

top
UncompressFileToString
BOOL CkUnixCompressW_UncompressFileToString(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *charset, const wchar_t *outStr);
const wchar_t *CkUnixCompressW_uncompressFileToString(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *charset);

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)
HCkTaskW CkUnixCompressW_UncompressFileToStringAsync(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *charset);

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 NULL on failure

top
UncompressMemory
BOOL CkUnixCompressW_UncompressMemory(HCkUnixCompressW cHandle, const unsigned char * inData, const unsigned char * outData);

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
BOOL CkUnixCompressW_UncompressMemToFile(HCkUnixCompressW cHandle, const unsigned char * inData, const wchar_t *destPath);

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
BOOL CkUnixCompressW_UncompressString(HCkUnixCompressW cHandle, const unsigned char * inCompressedData, const wchar_t *charset, const wchar_t *outStr);
const wchar_t *CkUnixCompressW_uncompressString(HCkUnixCompressW cHandle, const unsigned char * inCompressedData, const wchar_t *charset);

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
BOOL CkUnixCompressW_UnlockComponent(HCkUnixCompressW cHandle, const wchar_t *unlockCode);

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

Returns TRUE for success, FALSE for failure.

top
UnTarZ
BOOL CkUnixCompressW_UnTarZ(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *destDir, BOOL bNoAbsolute);

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)
HCkTaskW CkUnixCompressW_UnTarZAsync(HCkUnixCompressW cHandle, const wchar_t *zFilename, const wchar_t *destDir, BOOL bNoAbsolute);

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 NULL on failure

top