Compression Node.js Reference Documentation

Compression

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

var obj = new chilkat.Compression();

Properties

Algorithm
Algorithm
· string

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
Charset
· string

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
DebugLogFilePath
· string

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
DeflateLevel
· integer
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
EncodingMode
· string

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
LastErrorHtml
· string, read-only

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
LastErrorText
· string, read-only

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
LastErrorXml
· string, read-only

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
LastMethodSuccess
· boolean
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
VerboseLogging
· boolean

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
Version
· string, read-only

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

top

Methods

BeginCompressBytes
var retBuf = BeginCompressBytes(data);
· Returns a Buffer.

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

More Information and Examples
top
BeginCompressBytesAsync (1)
var ret_task = BeginCompressBytesAsync(data);
· Returns a Task
· data Buffer

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
var retStr = BeginCompressBytesENC(data);
· Returns a String.
· data Buffer

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

top
BeginCompressBytesENCAsync (1)
var ret_task = BeginCompressBytesENCAsync(data);
· Returns a Task
· data Buffer

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
var retBuf = BeginCompressString(str);
· Returns a Buffer.

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

More Information and Examples
top
BeginCompressStringAsync (1)
var ret_task = BeginCompressStringAsync(str);
· Returns a Task
· str String

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
var retStr = BeginCompressStringENC(str);
· Returns a String.
· str String

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

More Information and Examples
top
BeginCompressStringENCAsync (1)
var ret_task = BeginCompressStringENCAsync(str);
· Returns a Task
· str String

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
var retBuf = BeginDecompressBytes(data);
· Returns a Buffer.

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

More Information and Examples
top
BeginDecompressBytesAsync (1)
var ret_task = BeginDecompressBytesAsync(data);
· Returns a Task
· data Buffer

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
var retBuf = BeginDecompressBytesENC(str);
· Returns a Buffer.

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

top
BeginDecompressBytesENCAsync (1)
var ret_task = BeginDecompressBytesENCAsync(str);
· Returns a Task
· str String

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
var retStr = BeginDecompressString(data);
· Returns a String.
· data Buffer

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

More Information and Examples
top
BeginDecompressStringAsync (1)
var ret_task = BeginDecompressStringAsync(data);
· Returns a Task
· data Buffer

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
var retStr = BeginDecompressStringENC(str);
· Returns a String.
· str String

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

top
BeginDecompressStringENCAsync (1)
var ret_task = BeginDecompressStringENCAsync(str);
· Returns a Task
· str String

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
var status = CompressBd(binData);
· Returns Boolean (true for success, false for failure).
· binDatabool
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)
var ret_task = CompressBdAsync(binData);
· Returns a Task
· binDataTask
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
var retBuf = CompressBytes(data);
· Returns a Buffer.

Compresses byte data.

Returns null on failure

More Information and Examples
top
CompressBytesAsync (1)
var ret_task = CompressBytesAsync(data);
· Returns a Task
· data Buffer

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
var retStr = CompressBytesENC(data);
· Returns a String.
· data Buffer

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

Returns null on failure

top
CompressBytesENCAsync (1)
var ret_task = CompressBytesENCAsync(data);
· Returns a Task
· data Buffer

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
var status = CompressFile(srcPath, destPath);
· Returns Boolean (true for success, false for failure).
· srcPath String
· destPath String

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)
var ret_task = CompressFileAsync(srcPath, destPath);
· Returns a Task
· srcPath String
· destPath String

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
var status = CompressSb(sb, binData);
· Returns Boolean (true for success, false for failure).
· sbbool
· binDatabool
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)
var ret_task = CompressSbAsync(sb, binData);
· Returns a Task
· sbTask
· binDataTask
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
var status = CompressStream(strm);
· Returns Boolean (true for success, false for failure).
· strmbool
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)
var ret_task = CompressStreamAsync(strm);
· Returns a Task
· strmTask
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
var retBuf = CompressString(str);
· Returns a Buffer.

Compresses a string.

Returns null on failure

More Information and Examples
top
CompressStringAsync (1)
var ret_task = CompressStringAsync(str);
· Returns a Task
· str String

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
var retStr = CompressStringENC(str);
· Returns a String.
· str String

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

More Information and Examples
top
CompressStringENCAsync (1)
var ret_task = CompressStringENCAsync(str);
· Returns a Task
· str String

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
var status = DecompressBd(binData);
· Returns Boolean (true for success, false for failure).
· binDatabool
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)
var ret_task = DecompressBdAsync(binData);
· Returns a Task
· binDataTask
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
var retBuf = DecompressBytes(data);
· Returns a Buffer.

The opposite of CompressBytes.

Returns null on failure

More Information and Examples
top
DecompressBytesAsync (1)
var ret_task = DecompressBytesAsync(data);
· Returns a Task
· data Buffer

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
var retBuf = DecompressBytesENC(encodedCompressedData);
· Returns a Buffer.

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

Returns null on failure

top
DecompressBytesENCAsync (1)
var ret_task = DecompressBytesENCAsync(encodedCompressedData);
· Returns a Task
· encodedCompressedData String

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
var status = DecompressFile(srcPath, destPath);
· Returns Boolean (true for success, false for failure).
· srcPath String
· destPath String

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)
var ret_task = DecompressFileAsync(srcPath, destPath);
· Returns a Task
· srcPath String
· destPath String

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
var status = DecompressSb(binData, sb);
· Returns Boolean (true for success, false for failure).
· binDatabool
· sbbool
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)
var ret_task = DecompressSbAsync(binData, sb);
· Returns a Task
· binDataTask
· sbTask
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
var status = DecompressStream(strm);
· Returns Boolean (true for success, false for failure).
· strmbool
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)
var ret_task = DecompressStreamAsync(strm);
· Returns a Task
· strmTask
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
var retStr = DecompressString(data);
· Returns a String.
· data Buffer

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

Returns null on failure

More Information and Examples
top
DecompressStringAsync (1)
var ret_task = DecompressStringAsync(data);
· Returns a Task
· data Buffer

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
var retStr = DecompressStringENC(encodedCompressedData);
· Returns a String.
· encodedCompressedData String

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

Returns null on failure

More Information and Examples
top
DecompressStringENCAsync (1)
var ret_task = DecompressStringENCAsync(encodedCompressedData);
· Returns a Task
· encodedCompressedData String

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
var retBuf = EndCompressBytes();
· Returns a Buffer.

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

(See BeginCompressBytes)

Returns null on failure

More Information and Examples
top
EndCompressBytesAsync (1)
var ret_task = EndCompressBytesAsync();
· Returns a Task

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
var retStr = EndCompressBytesENC();
· Returns a String.

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

(See BeginCompressBytesENC)

Returns null on failure

top
EndCompressBytesENCAsync (1)
var ret_task = EndCompressBytesENCAsync();
· Returns a Task

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
var retBuf = EndCompressString();
· Returns a Buffer.

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

(See BeginCompressString)

Returns null on failure

More Information and Examples
top
EndCompressStringAsync (1)
var ret_task = EndCompressStringAsync();
· Returns a Task

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
var retStr = EndCompressStringENC();
· Returns a String.

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

(See BeginCompressStringENC)

Returns null on failure

More Information and Examples
top
EndCompressStringENCAsync (1)
var ret_task = EndCompressStringENCAsync();
· Returns a Task

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
var retBuf = EndDecompressBytes();
· Returns a Buffer.

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

(See BeginDecompressBytes)

Returns null on failure

More Information and Examples
top
EndDecompressBytesAsync (1)
var ret_task = EndDecompressBytesAsync();
· Returns a Task

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
var retBuf = EndDecompressBytesENC();
· Returns a Buffer.

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

top
EndDecompressBytesENCAsync (1)
var ret_task = EndDecompressBytesENCAsync();
· Returns a Task

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
var retStr = EndDecompressString();
· Returns a String.

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

(See BeginDecompressString)

Returns null on failure

More Information and Examples
top
EndDecompressStringAsync (1)
var ret_task = EndDecompressStringAsync();
· Returns a Task

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
var retStr = EndDecompressStringENC();
· Returns a String.

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

top
EndDecompressStringENCAsync (1)
var ret_task = EndDecompressStringENCAsync();
· Returns a Task

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
var retBuf = MoreCompressBytes(data);
· Returns a Buffer.

(See BeginCompressBytes)

Returns null on failure

More Information and Examples
top
MoreCompressBytesAsync (1)
var ret_task = MoreCompressBytesAsync(data);
· Returns a Task
· data Buffer

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
var retStr = MoreCompressBytesENC(data);
· Returns a String.
· data Buffer

(See BeginCompressBytesENC)

Returns null on failure

top
MoreCompressBytesENCAsync (1)
var ret_task = MoreCompressBytesENCAsync(data);
· Returns a Task
· data Buffer

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
var retBuf = MoreCompressString(str);
· Returns a Buffer.

(See BeginCompressString)

Returns null on failure

More Information and Examples
top
MoreCompressStringAsync (1)
var ret_task = MoreCompressStringAsync(str);
· Returns a Task
· str String

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
var retStr = MoreCompressStringENC(str);
· Returns a String.
· str String

(See BeginCompressStringENC)

Returns null on failure

More Information and Examples
top
MoreCompressStringENCAsync (1)
var ret_task = MoreCompressStringENCAsync(str);
· Returns a Task
· str String

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
var retBuf = MoreDecompressBytes(data);
· Returns a Buffer.

(See BeginDecompressBytes)

Returns null on failure

More Information and Examples
top
MoreDecompressBytesAsync (1)
var ret_task = MoreDecompressBytesAsync(data);
· Returns a Task
· data Buffer

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
var retBuf = MoreDecompressBytesENC(str);
· Returns a Buffer.

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

top
MoreDecompressBytesENCAsync (1)
var ret_task = MoreDecompressBytesENCAsync(str);
· Returns a Task
· str String

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
var retStr = MoreDecompressString(data);
· Returns a String.
· data Buffer

(See BeginDecompressString)

Returns null on failure

More Information and Examples
top
MoreDecompressStringAsync (1)
var ret_task = MoreDecompressStringAsync(data);
· Returns a Task
· data Buffer

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
var retStr = MoreDecompressStringENC(str);
· Returns a String.
· str String

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

top
MoreDecompressStringENCAsync (1)
var ret_task = MoreDecompressStringENCAsync(str);
· Returns a Task
· str String

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
var status = SaveLastError(path);
· Returns Boolean (true for success, false for failure).
· path String

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

Returns true for success, false for failure.

top
UnlockComponent
var status = UnlockComponent(unlockCode);
· Returns Boolean (true for success, false for failure).
· unlockCode String

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