CkCompression PHP Extension Reference Documentation

CkCompression

Current Version: 9.5.0.75

Data compression component 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.

Object Creation

$obj = new CkCompression();

Properties

Algorithm
string algorithm();
void put_Algorithm(string strVal);

The compression algorithm to be used. Should be set to either "ppmd", "deflate", "zlib", "bzip2", or "lzw".

Note: The PPMD compression algorithm is only available for 32-bit builds. It is not available for 64-bit implementations. Also, this PPMD implementation is the "J" variant.

top
Charset
string charset();
void put_Charset(string strVal);

Only applies to methods that compress or decompress strings. This specifies the character encoding that the string should be converted to before compression. Many programming languages use Unicode (2 bytes per char) for representing characters. This property allows for the string to be converted to a 1-byte per char encoding prior to compression.

top
DebugLogFilePath
string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

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
DeflateLevel
int get_DeflateLevel()
void put_DeflateLevel(int intVal);
Introduced in version 9.5.0.73

This property allows for customization of the compression level for the "deflate" and "zlib" compression algoirthms. ("zlib" is just the deflate algorithm with a zlib header.) A value of 0 = no compression, while 9 = maximum compression. The default is 6.

top
EncodingMode
string encodingMode();
void put_EncodingMode(string strVal);

Controls the encoding expected by methods ending in "ENC", such as CompressBytesENC. Valid values are "base64", "hex", "url", and "quoted-printable". Compression methods ending in ENC return the binary compressed data as an encoded string using this encoding. Decompress methods expect the input string to be this encoding.

top
LastErrorHtml
(read-only)
string lastErrorHtml();

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
(read-only)
string lastErrorText();

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
(read-only)
string lastErrorXml();

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 get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);
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
Utf8
bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

top
VerboseLogging
bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

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
(read-only)
string version();

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

top

Methods

BeginCompressBytes
bool BeginCompressBytes(CkByteData data, CkByteData outData);

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytes, followed by 0 or more calls to MoreCompressedBytes, and ending with a final call to EndCompressBytes. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

More Information and Examples
top
BeginCompressBytesAsync (1)
CkTask BeginCompressBytesAsync(CkByteData data);

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

Returns null on failure

top
BeginCompressBytesENC
bool BeginCompressBytesENC(CkByteData data, CkString outStr);
string beginCompressBytesENC(CkByteData data);

Large amounts of binary byte data may be compressed in chunks by first calling BeginCompressBytesENC, followed by 0 or more calls to MoreCompressedBytesENC, and ending with a final call to EndCompressBytesENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

top
BeginCompressBytesENCAsync (1)
CkTask BeginCompressBytesENCAsync(CkByteData data);

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

Returns null on failure

top
BeginCompressString
bool BeginCompressString(string str, CkByteData outData);

Large amounts of string data may be compressed in chunks by first calling BeginCompressString, followed by 0 or more calls to MoreCompressedString, and ending with a final call to EndCompressString. Each call returns 0 or more bytes of compressed data which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

More Information and Examples
top
BeginCompressStringAsync (1)
CkTask BeginCompressStringAsync(string str);

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

Returns null on failure

top
BeginCompressStringENC
bool BeginCompressStringENC(string str, CkString outStr);
string beginCompressStringENC(string str);

Large amounts of string data may be compressed in chunks by first calling BeginCompressStringENC, followed by 0 or more calls to MoreCompressedStringENC, and ending with a final call to EndCompressStringENC. Each call returns 0 or more characters of compressed data (encoded as a string according to the EncodingMode property setting) which may be output to a compressed data stream (such as a file, socket, etc.).

Returns true for success, false for failure.

More Information and Examples
top
BeginCompressStringENCAsync (1)
CkTask BeginCompressStringENCAsync(string str);

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

Returns null on failure

top
BeginDecompressBytes
bool BeginDecompressBytes(CkByteData data, CkByteData outData);

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytes, followed by 0 or more calls to MoreDecompressedBytes, and ending with a final call to EndDecompressBytes. Each call returns 0 or more bytes of decompressed data.

Returns true for success, false for failure.

More Information and Examples
top
BeginDecompressBytesAsync (1)
CkTask BeginDecompressBytesAsync(CkByteData data);

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

Returns null on failure

top
BeginDecompressBytesENC
bool BeginDecompressBytesENC(string str, CkByteData outData);

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressBytesENC, followed by 0 or more calls to MoreDecompressedBytesENC, and ending with a final call to EndDecompressBytesENC. Each call returns 0 or more bytes of decompressed data.

Returns true for success, false for failure.

top
BeginDecompressBytesENCAsync (1)
CkTask BeginDecompressBytesENCAsync(string str);

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

Returns null on failure

top
BeginDecompressString
bool BeginDecompressString(CkByteData data, CkString outStr);
string beginDecompressString(CkByteData data);

A compressed data stream may be decompressed in chunks by first calling BeginDecompressString, followed by 0 or more calls to MoreDecompressedString, and ending with a final call to EndDecompressString. Each call returns 0 or more characters of decompressed text.

Returns true for success, false for failure.

More Information and Examples
top
BeginDecompressStringAsync (1)
CkTask BeginDecompressStringAsync(CkByteData data);

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

Returns null on failure

top
BeginDecompressStringENC
bool BeginDecompressStringENC(string str, CkString outStr);
string beginDecompressStringENC(string str);

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

A compressed data stream may be decompressed in chunks by first calling BeginDecompressStringENC, followed by 0 or more calls to MoreDecompressedStringENC, and ending with a final call to EndDecompressStringENC. Each call returns 0 or more characters of decompressed text.

Returns true for success, false for failure.

top
BeginDecompressStringENCAsync (1)
CkTask BeginDecompressStringENCAsync(string str);

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

Returns null on failure

top
CompressBd
bool CompressBd(CkBinData binData);
Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns true for success, false for failure.

top
CompressBdAsync (1)
CkTask CompressBdAsync(CkBinData binData);
Introduced in version 9.5.0.66

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

Returns null on failure

top
CompressBytes
bool CompressBytes(CkByteData data, CkByteData outData);

Compresses byte data.

Returns true for success, false for failure.

More Information and Examples
top
CompressBytesAsync (1)
CkTask CompressBytesAsync(CkByteData data);

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

Returns null on failure

top
CompressBytesENC
bool CompressBytesENC(CkByteData data, CkString outStr);
string compressBytesENC(CkByteData data);

Compresses bytes and returns the compressed data encoded to a string. The encoding (hex, base64, etc.) is determined by the EncodingMode property setting.

Returns true for success, false for failure.

top
CompressBytesENCAsync (1)
CkTask CompressBytesENCAsync(CkByteData data);

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

Returns null on failure

top
CompressFile
bool CompressFile(string srcPath, string destPath);

Performs file-to-file compression. Files of any size may be compressed because the file is compressed internally in streaming mode.

Returns true for success, false for failure.

More Information and Examples
top
CompressFileAsync (1)
CkTask CompressFileAsync(string srcPath, string 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
CompressSb
bool CompressSb(CkStringBuilder sb, CkBinData binData);
Introduced in version 9.5.0.73

Compresses the contents of sb and appends the compressed bytes to binData.

Returns true for success, false for failure.

top
CompressSbAsync (1)
CkTask CompressSbAsync(CkStringBuilder sb, CkBinData binData);
Introduced in version 9.5.0.73

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

Returns null on failure

top
CompressStream
bool CompressStream(CkStream strm);
Introduced in version 9.5.0.56

Compresses a stream. Internally, the strm's source is read, compressed, and the compressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be compressed with stable ungrowing memory usage.

Returns true for success, false for failure.

More Information and Examples
top
CompressStreamAsync (1)
CkTask CompressStreamAsync(CkStream strm);
Introduced in version 9.5.0.56

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

Returns null on failure

top
CompressString
bool CompressString(string str, CkByteData outData);

Compresses a string.

Returns true for success, false for failure.

More Information and Examples
top
CompressStringAsync (1)
CkTask CompressStringAsync(string str);

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

Returns null on failure

top
CompressStringENC
bool CompressStringENC(string str, CkString outStr);
string compressStringENC(string str);

Compresses a string and returns the compressed data encoded to a string. The output encoding (hex, base64, etc.) is determined by the EncodingMode property setting.

Returns true for success, false for failure.

More Information and Examples
top
CompressStringENCAsync (1)
CkTask CompressStringENCAsync(string str);

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

Returns null on failure

top
DecompressBd
bool DecompressBd(CkBinData binData);
Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns true for success, false for failure.

top
DecompressBdAsync (1)
CkTask DecompressBdAsync(CkBinData binData);
Introduced in version 9.5.0.66

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

Returns null on failure

top
DecompressBytes
bool DecompressBytes(CkByteData data, CkByteData outData);

The opposite of CompressBytes.

Returns true for success, false for failure.

More Information and Examples
top
DecompressBytesAsync (1)
CkTask DecompressBytesAsync(CkByteData data);

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

Returns null on failure

top
DecompressBytesENC
bool DecompressBytesENC(string encodedCompressedData, CkByteData outData);

The opposite of CompressBytesENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting.

Returns true for success, false for failure.

top
DecompressBytesENCAsync (1)
CkTask DecompressBytesENCAsync(string encodedCompressedData);

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

Returns null on failure

top
DecompressFile
bool DecompressFile(string srcPath, string destPath);

Performs file-to-file decompression (the opposite of CompressFile). Internally the file is decompressed in streaming mode which allows files of any size to be decompressed.

Returns true for success, false for failure.

More Information and Examples
top
DecompressFileAsync (1)
CkTask DecompressFileAsync(string srcPath, string destPath);

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

Returns null on failure

top
DecompressSb
bool DecompressSb(CkBinData binData, CkStringBuilder sb);
Introduced in version 9.5.0.73

Decompresses the contents of binData and appends the decompressed string to sb.

Returns true for success, false for failure.

top
DecompressSbAsync (1)
CkTask DecompressSbAsync(CkBinData binData, CkStringBuilder sb);
Introduced in version 9.5.0.73

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

Returns null on failure

top
DecompressStream
bool DecompressStream(CkStream strm);
Introduced in version 9.5.0.56

Decompresses a stream. Internally, the strm's source is read, decompressed, and the decompressed data written to the strm's sink. It does this in streaming fashion. Extremely large or even infinite streams can be decompressed with stable ungrowing memory usage.

Returns true for success, false for failure.

More Information and Examples
top
DecompressStreamAsync (1)
CkTask DecompressStreamAsync(CkStream strm);
Introduced in version 9.5.0.56

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

Returns null on failure

top
DecompressString
bool DecompressString(CkByteData data, CkString outStr);
string decompressString(CkByteData data);

Takes compressed bytes, decompresses, and returns the resulting string.

Returns true for success, false for failure.

More Information and Examples
top
DecompressStringAsync (1)
CkTask DecompressStringAsync(CkByteData data);

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

Returns null on failure

top
DecompressStringENC
bool DecompressStringENC(string encodedCompressedData, CkString outStr);
string decompressStringENC(string encodedCompressedData);

The opposite of CompressStringENC. encodedCompressedData contains the compressed data as an encoded string (hex, base64, etc) as specified by the EncodingMode property setting.

Returns true for success, false for failure.

More Information and Examples
top
DecompressStringENCAsync (1)
CkTask DecompressStringENCAsync(string encodedCompressedData);

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

Returns null on failure

top
EndCompressBytes
bool EndCompressBytes(CkByteData outData);

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
EndCompressBytesAsync (1)
CkTask EndCompressBytesAsync();

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

Returns null on failure

top
EndCompressBytesENC
bool EndCompressBytesENC(CkString outStr);
string endCompressBytesENC();

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressBytesENC)

Returns true for success, false for failure.

top
EndCompressBytesENCAsync (1)
CkTask EndCompressBytesENCAsync();

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

Returns null on failure

top
EndCompressString
bool EndCompressString(CkByteData outData);

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressString)

Returns true for success, false for failure.

More Information and Examples
top
EndCompressStringAsync (1)
CkTask EndCompressStringAsync();

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

Returns null on failure

top
EndCompressStringENC
bool EndCompressStringENC(CkString outStr);
string endCompressStringENC();

Must be callled to finalize a compression stream. Returns any remaining (buffered) compressed data.

(See BeginCompressStringENC)

Returns true for success, false for failure.

More Information and Examples
top
EndCompressStringENCAsync (1)
CkTask EndCompressStringENCAsync();

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

Returns null on failure

top
EndDecompressBytes
bool EndDecompressBytes(CkByteData outData);

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
EndDecompressBytesAsync (1)
CkTask EndDecompressBytesAsync();

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

Returns null on failure

top
EndDecompressBytesENC
bool EndDecompressBytesENC(CkByteData outData);

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns true for success, false for failure.

top
EndDecompressBytesENCAsync (1)
CkTask EndDecompressBytesENCAsync();

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

Returns null on failure

top
EndDecompressString
bool EndDecompressString(CkString outStr);
string endDecompressString();

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

(See BeginDecompressString)

Returns true for success, false for failure.

More Information and Examples
top
EndDecompressStringAsync (1)
CkTask EndDecompressStringAsync();

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

Returns null on failure

top
EndDecompressStringENC
bool EndDecompressStringENC(CkString outStr);
string endDecompressStringENC();

Called to finalize the decompression stream and return any remaining (buffered) decompressed data.

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns true for success, false for failure.

top
EndDecompressStringENCAsync (1)
CkTask EndDecompressStringENCAsync();

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

Returns null on failure

top
MoreCompressBytes
bool MoreCompressBytes(CkByteData data, CkByteData outData);

(See BeginCompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
MoreCompressBytesAsync (1)
CkTask MoreCompressBytesAsync(CkByteData data);

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

Returns null on failure

top
MoreCompressBytesENC
bool MoreCompressBytesENC(CkByteData data, CkString outStr);
string moreCompressBytesENC(CkByteData data);

(See BeginCompressBytesENC)

Returns true for success, false for failure.

top
MoreCompressBytesENCAsync (1)
CkTask MoreCompressBytesENCAsync(CkByteData data);

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

Returns null on failure

top
MoreCompressString
bool MoreCompressString(string str, CkByteData outData);

(See BeginCompressString)

Returns true for success, false for failure.

More Information and Examples
top
MoreCompressStringAsync (1)
CkTask MoreCompressStringAsync(string str);

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

Returns null on failure

top
MoreCompressStringENC
bool MoreCompressStringENC(string str, CkString outStr);
string moreCompressStringENC(string str);

(See BeginCompressStringENC)

Returns true for success, false for failure.

More Information and Examples
top
MoreCompressStringENCAsync (1)
CkTask MoreCompressStringENCAsync(string str);

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

Returns null on failure

top
MoreDecompressBytes
bool MoreDecompressBytes(CkByteData data, CkByteData outData);

(See BeginDecompressBytes)

Returns true for success, false for failure.

More Information and Examples
top
MoreDecompressBytesAsync (1)
CkTask MoreDecompressBytesAsync(CkByteData data);

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

Returns null on failure

top
MoreDecompressBytesENC
bool MoreDecompressBytesENC(string str, CkByteData outData);

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressBytesENC)

Returns true for success, false for failure.

top
MoreDecompressBytesENCAsync (1)
CkTask MoreDecompressBytesENCAsync(string str);

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

Returns null on failure

top
MoreDecompressString
bool MoreDecompressString(CkByteData data, CkString outStr);
string moreDecompressString(CkByteData data);

(See BeginDecompressString)

Returns true for success, false for failure.

More Information and Examples
top
MoreDecompressStringAsync (1)
CkTask MoreDecompressStringAsync(CkByteData data);

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

Returns null on failure

top
MoreDecompressStringENC
bool MoreDecompressStringENC(string str, CkString outStr);
string moreDecompressStringENC(string str);

The input to this method is an encoded string containing compressed data. The EncodingMode property should be set prior to calling this method. The input string is decoded according to the EncodingMode (hex, base64, etc.) and then decompressed.

(See BeginDecompressStringENC)

Returns true for success, false for failure.

top
MoreDecompressStringENCAsync (1)
CkTask MoreDecompressStringENCAsync(string str);

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

Returns null on failure

top
SaveLastError
bool SaveLastError(string path);

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

Returns true for success, false for failure.

top
UnlockComponent
bool UnlockComponent(string unlockCode);

Unlocks the component allowing for the full functionality to be used. The component may be used fully-functional for the 1st 30-days after download by passing an arbitrary string to this method. If for some reason you do not receive the full 30-day trial, send email to support@chilkatsoft.com for a temporary unlock code w/ an explicit expiration date. Upon purchase, a purchased unlock code is provided which should replace the temporary/arbitrary string passed to this method.

Returns true for success, false for failure.

top