ZipCrc Tcl Reference Documentation
ZipCrc
Current Version: 10.0.0
Calculate a Zip CRC checksum for a file or in-memory data.
Object Creation
set myZipCrc [new CkZipCrc]
Properties
DebugLogFilePath
# ckStr is a CkString
CkZipCrc_get_DebugLogFilePath $myZipCrc $ckStr
set strVal [CkZipCrc_get_debugLogFilePath $myZipCrc]
CkZipCrc_put_DebugLogFilePath $myZipCrc $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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
# ckStr is a CkString
CkZipCrc_get_LastErrorHtml $myZipCrc $ckStr
set strVal [CkZipCrc_get_lastErrorHtml $myZipCrc]
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.
topLastErrorText
# ckStr is a CkString
CkZipCrc_get_LastErrorText $myZipCrc $ckStr
set strVal [CkZipCrc_get_lastErrorText $myZipCrc]
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.
LastErrorXml
# ckStr is a CkString
CkZipCrc_get_LastErrorXml $myZipCrc $ckStr
set strVal [CkZipCrc_get_lastErrorXml $myZipCrc]
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.
topLastMethodSuccess
set boolVal [CkZipCrc_get_LastMethodSuccess $myZipCrc]
CkZipCrc_put_LastMethodSuccess $myZipCrc $boolVal
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.
topUtf8
set boolVal [CkZipCrc_get_Utf8 $myZipCrc]
CkZipCrc_put_Utf8 $myZipCrc $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.
topVerboseLogging
set boolVal [CkZipCrc_get_VerboseLogging $myZipCrc]
CkZipCrc_put_VerboseLogging $myZipCrc $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.
topVersion
# ckStr is a CkString
CkZipCrc_get_Version $myZipCrc $ckStr
set strVal [CkZipCrc_get_version $myZipCrc]
Methods
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.
topCalculateCrc
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.
topCrcBd
set retInt [CkZipCrc_CrcBd $bd]
Calculates a CRC32 for the bytes contained in bd.
topCrcSb
# charset is a string
set retInt [CkZipCrc_CrcSb $sb $charset]
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.
topCrcString
# charset is a string
set retInt [CkZipCrc_CrcString $str $charset]
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.
topEndStream
Finalizes and returns the Zip CRC value calculated by calling BeginStream followed by multiple calls to MoreData.
topFileCrc
set retInt [CkZipCrc_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.
FileCrcAsync (1)
# path is a string
set ret_task [CkZipCrc_FileCrcAsync $path]
Creates an asynchronous task to call the FileCrc method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns NULL on failure
topLoadTaskCaller
set status [CkZipCrc_LoadTaskCaller $task]
MoreData
Adds additional data to the CRC currently being calculated. (See BeginStream for more information.)
topToHex
# outStr is a CkString (output)
set status [CkZipCrc_ToHex $crc $outStr]
set retStr [CkZipCrc_toHex $myZipCrc $crc]