CkBz2 Perl Reference Documentation

CkBz2

Current Version: 10.1.0

Requires Chilkat Bundle License

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 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

# $strVal is a string
# $ckStr is a CkString
$bz2->get_LastErrorHtml($ckStr);
$strVal = $bz2->lastErrorHtml();

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

# $strVal is a string
# $ckStr is a CkString
$bz2->get_LastErrorText($ckStr);
$strVal = $bz2->lastErrorText();

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

# $strVal is a string
# $ckStr is a CkString
$bz2->get_LastErrorXml($ckStr);
$strVal = $bz2->lastErrorXml();

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $bz2->get_LastMethodSuccess();
$bz2->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

Utf8

# $boolVal is a boolean
$boolVal = $bz2->get_Utf8();
$bz2->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.

VerboseLogging

# $boolVal is a boolean
$boolVal = $bz2->get_VerboseLogging();
$bz2->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.

Version

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

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

More Information and Examples

How to get the Chilkat version at runtime.

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).

Note: Both inFilename and toPath should be relative or absolute file paths (not just a path to a directory). For example "someDir1/someDir2/myFile.txt" or "c:/someDir1/myFile.bz2".

Returns 1 for success, 0 for failure.

More Information and Examples

bz2 Compress File

CompressFileAsync ⁽¹⁾

# 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.

Returns null on failure

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 1 for success, 0 for failure.

CompressFileToMemAsync ⁽¹⁾

# 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.

Returns null on failure

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 1 for success, 0 for failure.

CompressMemoryAsync ⁽¹⁾

# 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.

Returns null on failure

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 1 for success, 0 for failure.

CompressMemToFileAsync ⁽¹⁾

# 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.

Returns null on failure

LoadTaskCaller

# $task is a CkTask
$status = $bz2->LoadTaskCaller($task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

UncompressFile

# $inFilename is a string
# $toPath is a string
$status = $bz2->UncompressFile($inFilename, $toPath);

Unzips a .bz2 file.

Returns 1 for success, 0 for failure.

UncompressFileAsync ⁽¹⁾

# 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.

Returns null on failure

UncompressFileToMem

# $inFilename is a string
# $outBytes is a CkByteData (output)
$status = $bz2->UncompressFileToMem($inFilename, $outData);

Unzips a .bz2 file directly to memory.

Returns 1 for success, 0 for failure.

UncompressFileToMemAsync ⁽¹⁾

# 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.

Returns null on failure

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 1 for success, 0 for failure.

UncompressMemoryAsync ⁽¹⁾

# 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.

Returns null on failure

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 1 for success, 0 for failure.

UncompressMemToFileAsync ⁽¹⁾

# 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.

Returns null on failure