CkCompression Perl Reference Documentation

CkCompression

Current Version: 9.5.0.73

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 = chilkat::CkCompression()->new();

Properties

Algorithm
# $strVal is a string
# $ckStr is a CkString
$compression->get_Algorithm($ckStr);
$strVal = $compression->algorithm();
$compression->put_Algorithm($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
# $strVal is a string
# $ckStr is a CkString
$compression->get_Charset($ckStr);
$strVal = $compression->charset();
$compression->put_Charset($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
# $strVal is a string
# $ckStr is a CkString
$compression->get_DebugLogFilePath($ckStr);
$strVal = $compression->debugLogFilePath();
$compression->put_DebugLogFilePath($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
# $intVal is an integer
$intVal = $compression->get_DeflateLevel();
$compression->put_DeflateLevel($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
# $strVal is a string
# $ckStr is a CkString
$compression->get_EncodingMode($ckStr);
$strVal = $compression->encodingMode();
$compression->put_EncodingMode($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
# $strVal is a string
# $ckStr is a CkString
$compression->get_LastErrorHtml($ckStr);
$strVal = $compression->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
# $strVal is a string
# $ckStr is a CkString
$compression->get_LastErrorText($ckStr);
$strVal = $compression->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
# $strVal is a string
# $ckStr is a CkString
$compression->get_LastErrorXml($ckStr);
$strVal = $compression->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
# $boolVal is a boolean
$boolVal = $compression->get_LastMethodSuccess();
$compression->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Utf8
# $boolVal is a boolean
$boolVal = $compression->get_Utf8();
$compression->put_Utf8($boolVal);

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

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $compression->get_VerboseLogging();
$compression->put_VerboseLogging($boolVal);

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# $strVal is a string
# $ckStr is a CkString
$compression->get_Version($ckStr);
$strVal = $compression->version();

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

top

Methods

BeginCompressBytes
# $data is a CkByteData
# $outData is a CkByteData (output)
$status = $compression->BeginCompressBytes($data, $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 1 for success, 0 for failure.

More Information and Examples
top
BeginCompressBytesAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->BeginCompressBytesAsync($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
# $data is a CkByteData
# $outStr is a CkString (output)
$status = $compression->BeginCompressBytesENC($data, $outStr);
$retStr = $compression->beginCompressBytesENC($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 1 for success, 0 for failure.

top
BeginCompressBytesENCAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->BeginCompressBytesENCAsync($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
# $str is a string
# $outData is a CkByteData (output)
$status = $compression->BeginCompressString($str, $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 1 for success, 0 for failure.

More Information and Examples
top
BeginCompressStringAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->BeginCompressStringAsync($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
# $str is a string
# $outStr is a CkString (output)
$status = $compression->BeginCompressStringENC($str, $outStr);
$retStr = $compression->beginCompressStringENC($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 1 for success, 0 for failure.

More Information and Examples
top
BeginCompressStringENCAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->BeginCompressStringENCAsync($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
# $data is a CkByteData
# $outData is a CkByteData (output)
$status = $compression->BeginDecompressBytes($data, $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 1 for success, 0 for failure.

More Information and Examples
top
BeginDecompressBytesAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->BeginDecompressBytesAsync($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
# $str is a string
# $outData is a CkByteData (output)
$status = $compression->BeginDecompressBytesENC($str, $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 1 for success, 0 for failure.

top
BeginDecompressBytesENCAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->BeginDecompressBytesENCAsync($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
# $data is a CkByteData
# $outStr is a CkString (output)
$status = $compression->BeginDecompressString($data, $outStr);
$retStr = $compression->beginDecompressString($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 1 for success, 0 for failure.

More Information and Examples
top
BeginDecompressStringAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->BeginDecompressStringAsync($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
# $str is a string
# $outStr is a CkString (output)
$status = $compression->BeginDecompressStringENC($str, $outStr);
$retStr = $compression->beginDecompressStringENC($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 1 for success, 0 for failure.

top
BeginDecompressStringENCAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->BeginDecompressStringENCAsync($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
# $binData is a CkBinData
$status = $compression->CompressBd($binData);
Introduced in version 9.5.0.66

Compresses the data contained in a BinData object.

Returns 1 for success, 0 for failure.

top
CompressBdAsync (1)
# returns a CkTask
# $binData is a CkBinData
$ret_task = $compression->CompressBdAsync($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
# $data is a CkByteData
# $outData is a CkByteData (output)
$status = $compression->CompressBytes($data, $outData);

Compresses byte data.

Returns 1 for success, 0 for failure.

More Information and Examples
top
CompressBytesAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->CompressBytesAsync($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
# $data is a CkByteData
# $outStr is a CkString (output)
$status = $compression->CompressBytesENC($data, $outStr);
$retStr = $compression->compressBytesENC($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 1 for success, 0 for failure.

top
CompressBytesENCAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->CompressBytesENCAsync($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
# $srcPath is a string
# $destPath is a string
$status = $compression->CompressFile($srcPath, $destPath);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
CompressFileAsync (1)
# returns a CkTask
# $srcPath is a string
# $destPath is a string
$ret_task = $compression->CompressFileAsync($srcPath, $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
# $sb is a CkStringBuilder
# $binData is a CkBinData
$status = $compression->CompressSb($sb, $binData);
Introduced in version 9.5.0.73

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

Returns 1 for success, 0 for failure.

top
CompressSbAsync (1)
# returns a CkTask
# $sb is a CkStringBuilder
# $binData is a CkBinData
$ret_task = $compression->CompressSbAsync($sb, $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
# $strm is a CkStream
$status = $compression->CompressStream($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 1 for success, 0 for failure.

More Information and Examples
top
CompressStreamAsync (1)
# returns a CkTask
# $strm is a CkStream
$ret_task = $compression->CompressStreamAsync($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
# $str is a string
# $outData is a CkByteData (output)
$status = $compression->CompressString($str, $outData);

Compresses a string.

Returns 1 for success, 0 for failure.

More Information and Examples
top
CompressStringAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->CompressStringAsync($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
# $str is a string
# $outStr is a CkString (output)
$status = $compression->CompressStringENC($str, $outStr);
$retStr = $compression->compressStringENC($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 1 for success, 0 for failure.

More Information and Examples
top
CompressStringENCAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->CompressStringENCAsync($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
# $binData is a CkBinData
$status = $compression->DecompressBd($binData);
Introduced in version 9.5.0.66

Decompresses the data contained in a BinData object.

Returns 1 for success, 0 for failure.

top
DecompressBdAsync (1)
# returns a CkTask
# $binData is a CkBinData
$ret_task = $compression->DecompressBdAsync($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
# $data is a CkByteData
# $outData is a CkByteData (output)
$status = $compression->DecompressBytes($data, $outData);

The opposite of CompressBytes.

Returns 1 for success, 0 for failure.

More Information and Examples
top
DecompressBytesAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->DecompressBytesAsync($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
# $encodedCompressedData is a string
# $outData is a CkByteData (output)
$status = $compression->DecompressBytesENC($encodedCompressedData, $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 1 for success, 0 for failure.

top
DecompressBytesENCAsync (1)
# returns a CkTask
# $encodedCompressedData is a string
$ret_task = $compression->DecompressBytesENCAsync($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
# $srcPath is a string
# $destPath is a string
$status = $compression->DecompressFile($srcPath, $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 1 for success, 0 for failure.

More Information and Examples
top
DecompressFileAsync (1)
# returns a CkTask
# $srcPath is a string
# $destPath is a string
$ret_task = $compression->DecompressFileAsync($srcPath, $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
# $binData is a CkBinData
# $sb is a CkStringBuilder
$status = $compression->DecompressSb($binData, $sb);
Introduced in version 9.5.0.73

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

Returns 1 for success, 0 for failure.

top
DecompressSbAsync (1)
# returns a CkTask
# $binData is a CkBinData
# $sb is a CkStringBuilder
$ret_task = $compression->DecompressSbAsync($binData, $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
# $strm is a CkStream
$status = $compression->DecompressStream($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 1 for success, 0 for failure.

More Information and Examples
top
DecompressStreamAsync (1)
# returns a CkTask
# $strm is a CkStream
$ret_task = $compression->DecompressStreamAsync($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
# $data is a CkByteData
# $outStr is a CkString (output)
$status = $compression->DecompressString($data, $outStr);
$retStr = $compression->decompressString($data);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
DecompressStringAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->DecompressStringAsync($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
# $encodedCompressedData is a string
# $outStr is a CkString (output)
$status = $compression->DecompressStringENC($encodedCompressedData, $outStr);
$retStr = $compression->decompressStringENC($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 1 for success, 0 for failure.

More Information and Examples
top
DecompressStringENCAsync (1)
# returns a CkTask
# $encodedCompressedData is a string
$ret_task = $compression->DecompressStringENCAsync($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
# $outData is a CkByteData (output)
$status = $compression->EndCompressBytes($outData);

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

(See BeginCompressBytes)

Returns 1 for success, 0 for failure.

More Information and Examples
top
EndCompressBytesAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $outStr is a CkString (output)
$status = $compression->EndCompressBytesENC($outStr);
$retStr = $compression->endCompressBytesENC();

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

(See BeginCompressBytesENC)

Returns 1 for success, 0 for failure.

top
EndCompressBytesENCAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $outData is a CkByteData (output)
$status = $compression->EndCompressString($outData);

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

(See BeginCompressString)

Returns 1 for success, 0 for failure.

More Information and Examples
top
EndCompressStringAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $outStr is a CkString (output)
$status = $compression->EndCompressStringENC($outStr);
$retStr = $compression->endCompressStringENC();

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

(See BeginCompressStringENC)

Returns 1 for success, 0 for failure.

More Information and Examples
top
EndCompressStringENCAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $outData is a CkByteData (output)
$status = $compression->EndDecompressBytes($outData);

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

(See BeginDecompressBytes)

Returns 1 for success, 0 for failure.

More Information and Examples
top
EndDecompressBytesAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $outData is a CkByteData (output)
$status = $compression->EndDecompressBytesENC($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 1 for success, 0 for failure.

top
EndDecompressBytesENCAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $outStr is a CkString (output)
$status = $compression->EndDecompressString($outStr);
$retStr = $compression->endDecompressString();

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

(See BeginDecompressString)

Returns 1 for success, 0 for failure.

More Information and Examples
top
EndDecompressStringAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $outStr is a CkString (output)
$status = $compression->EndDecompressStringENC($outStr);
$retStr = $compression->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 1 for success, 0 for failure.

top
EndDecompressStringENCAsync (1)
# returns a CkTask
$ret_task = $compression->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
# $data is a CkByteData
# $outData is a CkByteData (output)
$status = $compression->MoreCompressBytes($data, $outData);

(See BeginCompressBytes)

Returns 1 for success, 0 for failure.

More Information and Examples
top
MoreCompressBytesAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->MoreCompressBytesAsync($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
# $data is a CkByteData
# $outStr is a CkString (output)
$status = $compression->MoreCompressBytesENC($data, $outStr);
$retStr = $compression->moreCompressBytesENC($data);

(See BeginCompressBytesENC)

Returns 1 for success, 0 for failure.

top
MoreCompressBytesENCAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->MoreCompressBytesENCAsync($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
# $str is a string
# $outData is a CkByteData (output)
$status = $compression->MoreCompressString($str, $outData);

(See BeginCompressString)

Returns 1 for success, 0 for failure.

More Information and Examples
top
MoreCompressStringAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->MoreCompressStringAsync($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
# $str is a string
# $outStr is a CkString (output)
$status = $compression->MoreCompressStringENC($str, $outStr);
$retStr = $compression->moreCompressStringENC($str);

(See BeginCompressStringENC)

Returns 1 for success, 0 for failure.

More Information and Examples
top
MoreCompressStringENCAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->MoreCompressStringENCAsync($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
# $data is a CkByteData
# $outData is a CkByteData (output)
$status = $compression->MoreDecompressBytes($data, $outData);

(See BeginDecompressBytes)

Returns 1 for success, 0 for failure.

More Information and Examples
top
MoreDecompressBytesAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->MoreDecompressBytesAsync($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
# $str is a string
# $outData is a CkByteData (output)
$status = $compression->MoreDecompressBytesENC($str, $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 1 for success, 0 for failure.

top
MoreDecompressBytesENCAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->MoreDecompressBytesENCAsync($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
# $data is a CkByteData
# $outStr is a CkString (output)
$status = $compression->MoreDecompressString($data, $outStr);
$retStr = $compression->moreDecompressString($data);

(See BeginDecompressString)

Returns 1 for success, 0 for failure.

More Information and Examples
top
MoreDecompressStringAsync (1)
# returns a CkTask
# $data is a CkByteData
$ret_task = $compression->MoreDecompressStringAsync($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
# $str is a string
# $outStr is a CkString (output)
$status = $compression->MoreDecompressStringENC($str, $outStr);
$retStr = $compression->moreDecompressStringENC($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 1 for success, 0 for failure.

top
MoreDecompressStringENCAsync (1)
# returns a CkTask
# $str is a string
$ret_task = $compression->MoreDecompressStringENCAsync($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
# $path is a string
$status = $compression->SaveLastError($path);

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

Returns 1 for success, 0 for failure.

top
UnlockComponent
# $unlockCode is a string
$status = $compression->UnlockComponent($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 1 for success, 0 for failure.

top