ZipCrc Perl Reference Documentation

CkZipCrc

Current Version: 10.1.2

Requires Chilkat Bundle License

Calculate a Zip CRC checksum for a file or in-memory data.

Object Creation

$obj = chilkat::CkZipCrc->new();

Properties

DebugLogFilePath

# $strVal is a string
# $ckStr is a CkString
$zipCrc->get_DebugLogFilePath($ckStr);
$strVal = $zipCrc->debugLogFilePath();
$zipCrc->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
$zipCrc->get_LastErrorHtml($ckStr);
$strVal = $zipCrc->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
$zipCrc->get_LastErrorText($ckStr);
$strVal = $zipCrc->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
$zipCrc->get_LastErrorXml($ckStr);
$strVal = $zipCrc->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 = $zipCrc->get_LastMethodSuccess();
$zipCrc->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 = $zipCrc->get_Utf8();
$zipCrc->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 = $zipCrc->get_VerboseLogging();
$zipCrc->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
$zipCrc->get_Version($ckStr);
$strVal = $zipCrc->version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

BeginStream

$zipCrc->BeginStream();

Provides a way to calculate a CRC by streaming the data a chunk at a time. An application would start by calling BeginStream. Then it would add data by calling MoreData for each additional chunk. After the last chunk has been processed, the EndStream method is called to return the CRC.

CalculateCrc

# $data is a CkByteData
$retInt = $zipCrc->CalculateCrc($data);

Calculates a 32-bit CRC for in-memory byte data. This is the 32-bit CRC that would be found in a Zip file header if a file containing the data was added to a zip archive. Returns the CRC32 of the data.

CrcBd

# $bd is a CkBinData
$retInt = $zipCrc->CrcBd($bd);

Introduced in version 9.5.0.75

Calculates a CRC32 for the bytes contained in bd.

CrcSb

# $sb is a CkStringBuilder
# $charset is a string
$retInt = $zipCrc->CrcSb($sb, $charset);

Introduced in version 9.5.0.75

Calculates a CRC32 for the string contained in sb. The charset is the byte representation to be used for the sb when calculating the CRC32. It can be utf-8, utf-16, windows-1252, iso-8859-1, or any of the character encodings (charsets) listed at the link below.

CrcString

# $str is a string
# $charset is a string
$retInt = $zipCrc->CrcString($str, $charset);

Introduced in version 9.5.0.75

Calculates a CRC32 for a string. The charset is the byte representation to be used for the str when calculating the CRC32. It can be utf-8, utf-16, windows-1252, iso-8859-1, or any of the character encodings (charsets) listed at the link below.

EndStream

$retInt = $zipCrc->EndStream();

Finalizes and returns the Zip CRC value calculated by calling BeginStream followed by multiple calls to MoreData.

FileCrc

# $path is a string
$retInt = $zipCrc->FileCrc($path);

Calculates the CRC32 of a file. The data contained in the file is streamed for the calculation to keep the memory footprint small and constant. Returns the CRC32 of the file.

More Information and Examples

Compute CRC32 of a File

FileCrcAsync ⁽¹⁾

# returns a CkTask
# $path is a string
$ret_task = $zipCrc->FileCrcAsync($path);

Creates an asynchronous task to call the FileCrc method with the arguments provided.

Returns null on failure

LoadTaskCaller

# $task is a CkTask
$status = $zipCrc->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.

MoreData

# $data is a CkByteData
$zipCrc->MoreData($data);

Adds additional data to the CRC currently being calculated. (See BeginStream for more information.)

ToHex

# $crc is an integer
# $outStr is a CkString (output)
$status = $zipCrc->ToHex($crc, $outStr);
$retStr = $zipCrc->toHex($crc);

Converts a 32-bit integer to a hex string.

Returns 1 for success, 0 for failure.