---
product: Chilkat
product_version: 11.7.0
language: c
language_label: C
class: ZipCrc
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/c_CkZipCrcRef.html
---
# Chilkat ZipCrc — C — v11.7.0

> Chilkat 11.7.0 · language=c · class=ZipCrc
> Other versions: replace `11.7.0` in this URL. Other languages: `https://www.chilkatsoft.com/ai-docs/v/11.7.0/<lang>/classes/ZipCrc.md`.
> Language-wide rules (install, unlock, error model, strings/bytes): `https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/guide.md`.

## Purpose

**Calculate ZIP-compatible CRC32 values for files, bytes, strings, and streamed data.**

`Chilkat.ZipCrc` calculates the 32-bit CRC value used in ZIP file headers. It can compute CRC32 values for in-memory byte arrays, `BinData`, `StringBuilder` content, strings using a specified character encoding, and entire files. It also supports streaming CRC calculation, allowing applications to process large or incremental data in chunks without holding the full input in memory.

**CRC32 for byte data**

Use `CalculateCrc` to calculate a ZIP-style CRC32 value for an in-memory byte array.

**BinData support**

Use `CrcBd` when the input bytes are already stored in a `Chilkat.BinData` object.

**String CRCs**

Use `CrcString` or `CrcSb` to calculate CRC32 for text using a specific charset such as `utf-8`, `utf-16`, or `windows-1252`.

**File CRCs**

Use `FileCrc` to calculate the CRC32 of a file while streaming the file contents to keep memory usage small and constant.

**Streaming calculation**

Call `BeginStream`, add chunks with `MoreData`, and finish with `EndStream` when data arrives incrementally.

**Hex formatting**

Use `ToHex` to convert a 32-bit CRC integer into a readable hexadecimal string.

**Common pattern:** Use `FileCrc` for files, `CalculateCrc` or `CrcBd` for binary data already in memory, and `CrcString` or `CrcSb` for text where the byte representation depends on a charset. For large or chunked input, initialize the CRC with `BeginStream`, feed each block with `MoreData`, and call `EndStream` to obtain the final CRC32 value.

**ZIP compatibility note:** The CRC returned by this class is the same 32-bit CRC value that would appear in a ZIP file header for the same byte content. When calculating CRCs for strings, the selected charset matters because the CRC is computed over bytes, not abstract characters.

## Object creation, unlocking and error handling

**Create/Dispose**

```c
HCkZipCrc instance = CkZipCrc_Create();
// ...
CkZipCrc_Dispose(instance);
```

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

Call `Global.UnlockBundle` once at the start of the program, before using this or any other Chilkat class. Any string unlocks a fully functional 30-day trial; a purchased unlock code is used in production. See `guide.md` for the exact code in C.

## Members common to every Chilkat class

Documented once per language in `common-members.md`; listed here so this page is self-contained.

| Property | Signature | Access | Meaning |
|---|---|---|---|
| `DebugLogFilePath` | `void CkZipCrc_getDebugLogFilePath(HCkZipCrc cHandle, HCkString retval); void CkZipCrc_putDebugLogFilePath(HCkZipCrc cHandle, const char *newVal); const char *CkZipCrc_debugLogFilePath(HCkZipCrc cHandle);` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastErrorHtml` | `void CkZipCrc_getLastErrorHtml(HCkZipCrc cHandle, HCkString retval); const char *CkZipCrc_lastErrorHtml(HCkZipCrc cHandle);` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `void CkZipCrc_getLastErrorText(HCkZipCrc cHandle, HCkString retval); const char *CkZipCrc_lastErrorText(HCkZipCrc cHandle);` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `void CkZipCrc_getLastErrorXml(HCkZipCrc cHandle, HCkString retval); const char *CkZipCrc_lastErrorXml(HCkZipCrc cHandle);` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `BOOL CkZipCrc_getLastMethodSuccess(HCkZipCrc cHandle); void CkZipCrc_putLastMethodSuccess(HCkZipCrc cHandle, BOOL newVal);` | read/write | Indicates the success or failure of the most recent method call: `TRUE` means success, `FALSE` means failure. |
| `Utf8` | `BOOL CkZipCrc_getUtf8(HCkZipCrc cHandle); void CkZipCrc_putUtf8(HCkZipCrc cHandle, BOOL newVal);` | read/write | When set to `TRUE`, all `const char *` arguments and return values are interpreted as UTF-8 strings. |
| `VerboseLogging` | `BOOL CkZipCrc_getVerboseLogging(HCkZipCrc cHandle); void CkZipCrc_putVerboseLogging(HCkZipCrc cHandle, BOOL newVal);` | read/write | If set to `TRUE`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `void CkZipCrc_getVersion(HCkZipCrc cHandle, HCkString retval); const char *CkZipCrc_version(HCkZipCrc cHandle);` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BeginStream` | method | `void CkZipCrc_BeginStream(HCkZipCrc cHandle);` |
| `CrcBd` | method | `unsigned long CkZipCrc_CrcBd(HCkZipCrc cHandle, HCkBinData bd);` |
| `CrcSb` | method | `unsigned long CkZipCrc_CrcSb(HCkZipCrc cHandle, HCkStringBuilder sb, const char *charset);` |
| `CrcString` | method | `unsigned long CkZipCrc_CrcString(HCkZipCrc cHandle, const char *str, const char *charset);` |
| `EndStream` | method | `unsigned long CkZipCrc_EndStream(HCkZipCrc cHandle);` |
| `FileCrc` | method | `unsigned long CkZipCrc_FileCrc(HCkZipCrc cHandle, const char *path);` |
| `LoadTaskCaller` | method | `BOOL CkZipCrc_LoadTaskCaller(HCkZipCrc cHandle, HCkTask task);` |
| `ToHex` | method | `BOOL CkZipCrc_ToHex(HCkZipCrc cHandle, unsigned long crc, HCkString outStr); const char *CkZipCrc_toHex(HCkZipCrc cHandle, unsigned long crc);` |

Deprecated members are listed at the end of this file with their replacements; do not use them in new code.

## Methods

### ZipCrc.BeginStream

`Chilkat 11.7.0 · c · ZipCrc · BeginStream · method`

```c
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.

### ZipCrc.CrcBd

`Chilkat 11.7.0 · c · ZipCrc · CrcBd · method · since 9.5.0.75`

```c
unsigned long CkZipCrc_CrcBd(HCkZipCrc cHandle, HCkBinData bd);
```

Calculates a CRC32 for the bytes contained in `bd`.

### ZipCrc.CrcSb

`Chilkat 11.7.0 · c · ZipCrc · CrcSb · method · since 9.5.0.75`

```c
unsigned long CkZipCrc_CrcSb(HCkZipCrc cHandle, HCkStringBuilder sb, const char *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.

### ZipCrc.CrcString

`Chilkat 11.7.0 · c · ZipCrc · CrcString · method · since 9.5.0.75`

```c
unsigned long CkZipCrc_CrcString(HCkZipCrc cHandle, const char *str, const char *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.

### ZipCrc.EndStream

`Chilkat 11.7.0 · c · ZipCrc · EndStream · method`

```c
unsigned long CkZipCrc_EndStream(HCkZipCrc cHandle);
```

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

### ZipCrc.FileCrc

`Chilkat 11.7.0 · c · ZipCrc · FileCrc · method`

```c
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.

Async variant: `FileCrcAsync` — same arguments, returns a `Task` (see Async variants below).

### ZipCrc.LoadTaskCaller

`Chilkat 11.7.0 · c · ZipCrc · LoadTaskCaller · method · since 9.5.0.80`

```c
BOOL CkZipCrc_LoadTaskCaller(HCkZipCrc cHandle, HCkTask task);
```

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

### ZipCrc.ToHex

`Chilkat 11.7.0 · c · ZipCrc · ToHex · method`

```c
BOOL CkZipCrc_ToHex(HCkZipCrc cHandle, unsigned long crc, HCkString outStr);
const char *CkZipCrc_toHex(HCkZipCrc cHandle, unsigned long crc);
```

Converts a 32-bit integer to a hex string.

Returns TRUE for success, FALSE for failure.

## Events and callbacks

This binding delivers progress information through callbacks (AbortCheck, PercentDone, ProgressInfo, TaskCompleted) rather than events. See `guide.md` for how to attach them in C.

## Async variants

Each returns a `Task` instead of the result and takes the same arguments as the synchronous method; run the task, wait for `Finished`, then read the result from the task. No new Async methods are added from 11.7.0 on.

```c
HCkTask CkZipCrc_FileCrcAsync(HCkZipCrc cHandle, const char *path);
```

## Deprecated members — do not use in new code

| Member | Kind | Deprecated in | Use instead |
|---|---|---|---|
| `CalculateCrc` | method | before 11.6.1 | — |
| `MoreData` | method | before 11.6.1 | — |

## Related classes

[`BinData`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/c/classes/Task.md)

