CkBz2 Ruby Reference Documentation

CkBz2

Current Version: 9.5.0.75

Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.

Object Creation

obj = Chilkat::CkBz2.new()

Properties

AbortCurrent
# boolVal is a boolean
boolVal = bz2.get_AbortCurrent();
bz2.put_AbortCurrent(boolVal);
Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
bz2.get_DebugLogFilePath(ckStr);
strVal = bz2.debugLogFilePath();
bz2.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
LastErrorHtml
# strVal is a string
# ckStr is a CkString
bz2.get_LastErrorHtml(ckStr);
strVal = bz2.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
bz2.get_LastErrorText(ckStr);
strVal = bz2.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
bz2.get_LastErrorXml(ckStr);
strVal = bz2.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 = bz2.get_LastMethodSuccess();
bz2.put_LastMethodSuccess(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
# boolVal is a boolean
boolVal = bz2.get_Utf8();
bz2.put_Utf8(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
# boolVal is a boolean
boolVal = bz2.get_VerboseLogging();
bz2.put_VerboseLogging(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
# strVal is a string
# ckStr is a CkString
bz2.get_Version(ckStr);
strVal = bz2.version();

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

top

Methods

CompressFile
# inFilename is a string
# toPath is a string
status = bz2.CompressFile(inFilename, toPath);

Compresses a file to create a BZip2 compressed file (.bz2).

Returns true for success, false for failure.

top
CompressFileAsync (1)
# returns a CkTask
# inFilename is a string
# toPath is a string
ret_task = bz2.CompressFileAsync(inFilename, toPath);

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

top
CompressFileToMem
# inFilename is a string
# outBytes is a CkByteData (output)
status = bz2.CompressFileToMem(inFilename, outData);

BZip2 compresses a file to an in-memory image of a .bz2 file.

Returns true for success, false for failure.

top
CompressFileToMemAsync (1)
# returns a CkTask
# inFilename is a string
ret_task = bz2.CompressFileToMemAsync(inFilename);

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

Returns nil on failure

top
CompressMemory
# inData is a CkByteData
# outBytes is a CkByteData (output)
status = bz2.CompressMemory(inData, outData);

Compresses in-memory data to an in-memory image of a .bz2 file.

Returns true for success, false for failure.

top
CompressMemoryAsync (1)
# returns a CkTask
# inData is a CkByteData
ret_task = bz2.CompressMemoryAsync(inData);

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

Returns nil on failure

top
CompressMemToFile
# inData is a CkByteData
# toPath is a string
status = bz2.CompressMemToFile(inData, toPath);

BZip2 compresses and creates a .bz2 file from in-memory data.

Returns true for success, false for failure.

top
CompressMemToFileAsync (1)
# returns a CkTask
# inData is a CkByteData
# toPath is a string
ret_task = bz2.CompressMemToFileAsync(inData, toPath);

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

Returns nil on failure

top
SaveLastError
# path is a string
status = bz2.SaveLastError(path);

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

Returns true for success, false for failure.

top
UncompressFile
# inFilename is a string
# toPath is a string
status = bz2.UncompressFile(inFilename, toPath);

Unzips a .bz2 file.

Returns true for success, false for failure.

top
UncompressFileAsync (1)
# returns a CkTask
# inFilename is a string
# toPath is a string
ret_task = bz2.UncompressFileAsync(inFilename, toPath);

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

Returns nil on failure

top
UncompressFileToMem
# inFilename is a string
# outBytes is a CkByteData (output)
status = bz2.UncompressFileToMem(inFilename, outData);

Unzips a .bz2 file directly to memory.

Returns true for success, false for failure.

top
UncompressFileToMemAsync (1)
# returns a CkTask
# inFilename is a string
ret_task = bz2.UncompressFileToMemAsync(inFilename);

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

Returns nil on failure

top
UncompressMemory
# inData is a CkByteData
# outBytes is a CkByteData (output)
status = bz2.UncompressMemory(inData, outData);

Unzips from an in-memory image of a .bz2 file directly into memory.

Returns true for success, false for failure.

top
UncompressMemoryAsync (1)
# returns a CkTask
# inData is a CkByteData
ret_task = bz2.UncompressMemoryAsync(inData);

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

Returns nil on failure

top
UncompressMemToFile
# inData is a CkByteData
# toPath is a string
status = bz2.UncompressMemToFile(inData, toPath);

Unzips from an in-memory image of a .bz2 file to a file.

Returns true for success, false for failure.

top
UncompressMemToFileAsync (1)
# returns a CkTask
# inData is a CkByteData
# toPath is a string
ret_task = bz2.UncompressMemToFileAsync(inData, toPath);

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

Returns nil on failure

top
UnlockComponent
# regCode is a string
status = bz2.UnlockComponent(regCode);

Unlocks the component allowing for the full functionality to be used. If a purchased unlock code is passed, there is no expiration. Any other string automatically begins a fully-functional 30-day trial the first time UnlockComponent is called.

Returns true for success, false for failure.

top