ZipCrc C Reference Documentation


Current Version:

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


HCkZipCrc instance = CkZipCrc_Create();
// ...
HCkZipCrc CkZipCrc_Create(void);

Creates an instance of the HCkZipCrc object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkZipCrc_Dispose(HCkZipCrc handle);

Objects created by calling CkZipCrc_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkZipCrc_Dispose.

Callback Functions

Callback Functions introduced in Chilkat v9.5.0.56
void CkZipCrc_setAbortCheck(HCkZipCrc cHandle, BOOL (*fnAbortCheck)(void));

Provides the opportunity for a method call to be aborted. If TRUE is returned, the operation in progress is aborted. Return FALSE to allow the current method call to continue. This callback function is called periodically based on the value of the HeartbeatMs property. (If HeartbeatMs is 0, then no callbacks are made.) As an example, to make 5 AbortCheck callbacks per second, set the HeartbeatMs property equal to 200.

void CkZipCrc_setPercentDone(HCkZipCrc cHandle, BOOL (*fnPercentDone)(int pctDone));

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This callback is only called when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For methods that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

This callback counts as an AbortCheck callback, and takes the place of the AbortCheck event when it fires.

The return value indicates whether the method call should be aborted, or whether it should proceed. Return TRUE to abort, and FALSE to proceed.

void CkZipCrc_setProgressInfo(HCkZipCrc cHandle, void (*fnProgressInfo)(const char *name, const char *value));

This is a general callback that provides name/value information about what is happening at certain points during a method call. To see the information provided in ProgressInfo callbacks, if any, write code to handle this event and log the name/value pairs. Most are self-explanatory.

void CkZipCrc_setTaskCompleted(HCkZipCrc cHandle, void (*fnTaskCompleted)(HCkTask hTask));

Called in the background thread when an asynchronous task completes. (Note: When an async method is running, all callbacks are in the background thread.)


BOOL CkZipCrc_getLastMethodSuccess(HCkZipCrc cHandle);
void CkZipCrc_putLastMethodSuccess(HCkZipCrc cHandle, BOOL newVal);

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.

BOOL CkZipCrc_getUtf8(HCkZipCrc cHandle);
void CkZipCrc_putUtf8(HCkZipCrc cHandle, BOOL newVal);

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.



void CkZipCrc_BeginStream(HCkZipCrc cHandle);

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.

unsigned long CkZipCrc_CalculateCrc(HCkZipCrc cHandle, HCkByteData 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.

unsigned long CkZipCrc_EndStream(HCkZipCrc cHandle);

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

unsigned long CkZipCrc_FileCrc(HCkZipCrc cHandle, const char *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)
HCkTask CkZipCrc_FileCrcAsync(HCkZipCrc cHandle, const char *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

void CkZipCrc_MoreData(HCkZipCrc cHandle, HCkByteData data);

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

BOOL CkZipCrc_ToHex(HCkZipCrc cHandle, int crc, HCkString outStr);
const char *CkZipCrc_toHex(HCkZipCrc cHandle, int crc);

Converts a 32-bit integer to a hex string.

Returns TRUE for success, FALSE for failure.