Compression C Library Reference

Compression

Data compression C library implementing the PPMD, Bzip2, Deflate, and LZW compression algorithms. .NET, ActiveX, and C++ implementations provide progress monitoring and abort capabilities. Provides a unified API for all supported compression algorithms.

Create/Dispose

HCkCompression CkCompression_Create(void);

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

void CkCompression_Dispose(HCkCompression handle);

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

C "Properties"

void CkCompression_getAlgorithm(HCkCompression handle, HCkString retval);
void CkCompression_putAlgorithm(HCkCompression handle, const char *newVal);

To be documented soon...

void CkCompression_getCharset(HCkCompression handle, HCkString retval);
void CkCompression_putCharset(HCkCompression handle, const char *newVal);

To be documented soon...

void CkCompression_getEncodingMode(HCkCompression handle, HCkString retval);
void CkCompression_putEncodingMode(HCkCompression handle, const char *newVal);

To be documented soon...

void CkCompression_getLastErrorHtml(HCkCompression handle, HCkString retval);

Error information in HTML format for the last method called.

void CkCompression_getLastErrorText(HCkCompression handle, HCkString retval);

Error information in plain-text format for the last method called.

void CkCompression_getLastErrorXml(HCkCompression handle, HCkString retval);

Error information in XML format for the last method called.

BOOL CkCompression_getUtf8(HCkCompression handle);
void CkCompression_putUtf8(HCkCompression handle, BOOL newVal);

To be documented soon...

C "Methods"

BOOL CkCompression_BeginCompressBytes(HCkCompression handle, HCkByteData bData, HCkByteData out);

To be documented soon...

BOOL CkCompression_BeginCompressBytesENC(HCkCompression handle, HCkByteData bData, HCkString out);

To be documented soon...

BOOL CkCompression_BeginCompressString(HCkCompression handle, const char *str, HCkByteData out);

To be documented soon...

BOOL CkCompression_BeginCompressStringENC(HCkCompression handle, const char *str, HCkString out);

To be documented soon...

BOOL CkCompression_BeginDecompressBytes(HCkCompression handle, HCkByteData bData, HCkByteData out);

To be documented soon...

BOOL CkCompression_BeginDecompressBytesENC(HCkCompression handle, const char *str, HCkByteData out);

To be documented soon...

BOOL CkCompression_BeginDecompressString(HCkCompression handle, HCkByteData bData, HCkString out);

To be documented soon...

BOOL CkCompression_BeginDecompressStringENC(HCkCompression handle, const char *str, HCkString out);

To be documented soon...

BOOL CkCompression_CompressBytes(HCkCompression handle, HCkByteData bData, HCkByteData out);

To be documented soon...

BOOL CkCompression_CompressBytesENC(HCkCompression handle, HCkByteData bData, HCkString out);

To be documented soon...

BOOL CkCompression_CompressFile(HCkCompression handle, const char *inFile, const char *outFile);

To be documented soon...

BOOL CkCompression_CompressString(HCkCompression handle, const char *str, HCkByteData out);

To be documented soon...

BOOL CkCompression_CompressStringENC(HCkCompression handle, const char *str, HCkString out);

To be documented soon...

BOOL CkCompression_DecompressBytes(HCkCompression handle, HCkByteData bData, HCkByteData out);

To be documented soon...

BOOL CkCompression_DecompressBytesENC(HCkCompression handle, const char *str, HCkByteData out);

To be documented soon...

BOOL CkCompression_DecompressFile(HCkCompression handle, const char *inFile, const char *outFile);

To be documented soon...

BOOL CkCompression_DecompressString(HCkCompression handle, HCkByteData bData, HCkString out);

To be documented soon...

BOOL CkCompression_DecompressStringENC(HCkCompression handle, const char *str, HCkString out);

To be documented soon...

BOOL CkCompression_EndCompressBytes(HCkCompression handle, HCkByteData out);

To be documented soon...

BOOL CkCompression_EndCompressBytesENC(HCkCompression handle, HCkString out);

To be documented soon...

BOOL CkCompression_EndCompressString(HCkCompression handle, HCkByteData out);

To be documented soon...

BOOL CkCompression_EndCompressStringENC(HCkCompression handle, HCkString out);

To be documented soon...

BOOL CkCompression_EndDecompressBytes(HCkCompression handle, HCkByteData out);

To be documented soon...

BOOL CkCompression_EndDecompressBytesENC(HCkCompression handle, HCkByteData out);

To be documented soon...

BOOL CkCompression_EndDecompressString(HCkCompression handle, HCkString out);

To be documented soon...

BOOL CkCompression_EndDecompressStringENC(HCkCompression handle, HCkString out);

To be documented soon...

BOOL CkCompression_MoreCompressBytes(HCkCompression handle, HCkByteData bData, HCkByteData out);

To be documented soon...

BOOL CkCompression_MoreCompressBytesENC(HCkCompression handle, HCkByteData bData, HCkString out);

To be documented soon...

BOOL CkCompression_MoreCompressString(HCkCompression handle, const char *str, HCkByteData out);

To be documented soon...

BOOL CkCompression_MoreCompressStringENC(HCkCompression handle, const char *str, HCkString out);

To be documented soon...

BOOL CkCompression_MoreDecompressBytes(HCkCompression handle, HCkByteData bData, HCkByteData out);

To be documented soon...

BOOL CkCompression_MoreDecompressBytesENC(HCkCompression handle, const char *str, HCkByteData out);

To be documented soon...

BOOL CkCompression_MoreDecompressString(HCkCompression handle, HCkByteData bData, HCkString out);

To be documented soon...

BOOL CkCompression_MoreDecompressStringENC(HCkCompression handle, const char *str, HCkString out);

To be documented soon...

BOOL CkCompression_SaveLastError(HCkCompression handle, const char *filename);

Saves the last error information to an XML formatted file.

BOOL CkCompression_UnlockComponent(HCkCompression handle, const char *unlockCode);

To be documented soon...

const char *CkCompression_algorithm(HCkCompression handle);

To be documented soon...

const char *CkCompression_beginCompressBytesENC(HCkCompression handle, HCkByteData bData);

To be documented soon...

const char *CkCompression_beginCompressStringENC(HCkCompression handle, const char *str);

To be documented soon...

const char *CkCompression_beginDecompressString(HCkCompression handle, HCkByteData bData);

To be documented soon...

const char *CkCompression_beginDecompressStringENC(HCkCompression handle, const char *str);

To be documented soon...

const char *CkCompression_charset(HCkCompression handle);

To be documented soon...

const char *CkCompression_compressBytesENC(HCkCompression handle, HCkByteData bData);

To be documented soon...

const char *CkCompression_compressStringENC(HCkCompression handle, const char *str);

To be documented soon...

const char *CkCompression_decompressString(HCkCompression handle, HCkByteData bData);

To be documented soon...

const char *CkCompression_decompressStringENC(HCkCompression handle, const char *str);

To be documented soon...

const char *CkCompression_encodingMode(HCkCompression handle);

To be documented soon...

const char *CkCompression_endCompressBytesENC(HCkCompression handle);

To be documented soon...

const char *CkCompression_endCompressStringENC(HCkCompression handle);

To be documented soon...

const char *CkCompression_endDecompressString(HCkCompression handle);

To be documented soon...

const char *CkCompression_endDecompressStringENC(HCkCompression handle);

To be documented soon...

const char *CkCompression_lastErrorHtml(HCkCompression handle);

Error information in HTML format for the last method called.

const char *CkCompression_lastErrorText(HCkCompression handle);

Error information in plain-text format for the last method called.

const char *CkCompression_lastErrorXml(HCkCompression handle);

Error information in XML format for the last method called.

const char *CkCompression_moreCompressBytesENC(HCkCompression handle, HCkByteData bData);

To be documented soon...

const char *CkCompression_moreCompressStringENC(HCkCompression handle, const char *str);

To be documented soon...

const char *CkCompression_moreDecompressString(HCkCompression handle, HCkByteData bData);

To be documented soon...

const char *CkCompression_moreDecompressStringENC(HCkCompression handle, const char *str);

To be documented soon...