---
product: Chilkat
product_version: 11.7.0
language: delphidll
language_label: Delphi DLL
class: ZipCrc
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/dd_CkZipCrcRef.html
---
# Chilkat ZipCrc — Delphi DLL — v11.7.0

> Chilkat 11.7.0 · language=delphidll · 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/delphidll/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**

```pascal
var
myObject: HCkZipCrc;

begin
myObject := CkZipCrc_Create();

// ...

CkZipCrc_Dispose(myObject);
end;
```

`function CkZipCrc_Create: HCkZipCrc; stdcall;`

Creates an instance of the HCkZipCrc object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

`procedure CkZipCrc_Dispose(handle: HCkZipCrc); stdcall;`

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.

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 Delphi DLL.

## 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` | `procedure CkZipCrc_getDebugLogFilePath(objHandle: HCkZipCrc; outPropVal: HCkString); stdcall; procedure CkZipCrc_putDebugLogFilePath(objHandle: HCkZipCrc; newPropVal: PWideChar); stdcall; function CkZipCrc__debugLogFilePath(objHandle: HCkZipCrc): PWideChar; stdcall;` | 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` | `procedure CkZipCrc_getLastErrorHtml(objHandle: HCkZipCrc; outPropVal: HCkString); stdcall; function CkZipCrc__lastErrorHtml(objHandle: HCkZipCrc): PWideChar; stdcall;` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `procedure CkZipCrc_getLastErrorText(objHandle: HCkZipCrc; outPropVal: HCkString); stdcall; function CkZipCrc__lastErrorText(objHandle: HCkZipCrc): PWideChar; stdcall;` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `procedure CkZipCrc_getLastErrorXml(objHandle: HCkZipCrc; outPropVal: HCkString); stdcall; function CkZipCrc__lastErrorXml(objHandle: HCkZipCrc): PWideChar; stdcall;` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `function CkZipCrc_getLastMethodSuccess(objHandle: HCkZipCrc): wordbool; stdcall; procedure CkZipCrc_putLastMethodSuccess(objHandle: HCkZipCrc; newPropVal: wordbool); stdcall;` | read/write | Indicates the success or failure of the most recent method call: `True` means success, `False` means failure. |
| `VerboseLogging` | `function CkZipCrc_getVerboseLogging(objHandle: HCkZipCrc): wordbool; stdcall; procedure CkZipCrc_putVerboseLogging(objHandle: HCkZipCrc; newPropVal: wordbool); stdcall;` | read/write | If set to `True`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `procedure CkZipCrc_getVersion(objHandle: HCkZipCrc; outPropVal: HCkString); stdcall; function CkZipCrc__version(objHandle: HCkZipCrc): PWideChar; stdcall;` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BeginStream` | method | `procedure CkZipCrc_BeginStream(objHandle: HCkZipCrc) stdcall;` |
| `CrcBd` | method | `function CkZipCrc_CrcBd(objHandle: HCkZipCrc;     bd: HCkBinData): LongWord; stdcall;` |
| `CrcSb` | method | `function CkZipCrc_CrcSb(objHandle: HCkZipCrc;     sb: HCkStringBuilder;     charset: PWideChar): LongWord; stdcall;` |
| `CrcString` | method | `function CkZipCrc_CrcString(objHandle: HCkZipCrc;     str: PWideChar;     charset: PWideChar): LongWord; stdcall;` |
| `EndStream` | method | `function CkZipCrc_EndStream(objHandle: HCkZipCrc): LongWord; stdcall;` |
| `FileCrc` | method | `function CkZipCrc_FileCrc(objHandle: HCkZipCrc;     path: PWideChar): LongWord; stdcall;` |
| `LoadTaskCaller` | method | `function CkZipCrc_LoadTaskCaller(objHandle: HCkZipCrc;     task: HCkTask): wordbool; stdcall;` |
| `ToHex` | method | `function CkZipCrc_ToHex(objHandle: HCkZipCrc;     crc: LongWord;     outStr: HCkString): wordbool; stdcall; function CkZipCrc__toHex(objHandle: HCkZipCrc;     crc: LongWord): PWideChar; stdcall;` |

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 · delphidll · ZipCrc · BeginStream · method`

```pascal
procedure CkZipCrc_BeginStream(objHandle: HCkZipCrc) stdcall;
```

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 · delphidll · ZipCrc · CrcBd · method · since 9.5.0.75`

```pascal
function CkZipCrc_CrcBd(objHandle: HCkZipCrc;
    bd: HCkBinData): LongWord; stdcall;
```

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

### ZipCrc.CrcSb

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

```pascal
function CkZipCrc_CrcSb(objHandle: HCkZipCrc;
    sb: HCkStringBuilder;
    charset: PWideChar): LongWord; stdcall;
```

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 · delphidll · ZipCrc · CrcString · method · since 9.5.0.75`

```pascal
function CkZipCrc_CrcString(objHandle: HCkZipCrc;
    str: PWideChar;
    charset: PWideChar): LongWord; stdcall;
```

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 · delphidll · ZipCrc · EndStream · method`

```pascal
function CkZipCrc_EndStream(objHandle: HCkZipCrc): LongWord; stdcall;
```

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

### ZipCrc.FileCrc

`Chilkat 11.7.0 · delphidll · ZipCrc · FileCrc · method`

```pascal
function CkZipCrc_FileCrc(objHandle: HCkZipCrc;
    path: PWideChar): LongWord; stdcall;
```

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 · delphidll · ZipCrc · LoadTaskCaller · method · since 9.5.0.80`

```pascal
function CkZipCrc_LoadTaskCaller(objHandle: HCkZipCrc;
    task: HCkTask): wordbool; stdcall;
```

Loads the caller of the task's async method.

Returns True for success, False for failure.

### ZipCrc.ToHex

`Chilkat 11.7.0 · delphidll · ZipCrc · ToHex · method`

```pascal
function CkZipCrc_ToHex(objHandle: HCkZipCrc;
    crc: LongWord;
    outStr: HCkString): wordbool; stdcall;
function CkZipCrc__toHex(objHandle: HCkZipCrc;
    crc: LongWord): PWideChar; stdcall;
```

Converts a 32-bit integer to a hex string.

Returns True for success, False for failure.

See the notes about [PWideChar memory ownership and validity](https://www.chilkatsoft.com/delphi_pwidechar.asp).

## Events and callbacks

### ZipCrc.AbortCheck (event)

`Chilkat 11.7.0 · delphidll · ZipCrc · AbortCheck · event`

```pascal
function MyAbortCheck(): Integer; cdecl;
```

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the `HeartbeatMs` property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second. Return `True` to abort; return `False` to continue (not abort)

### ZipCrc.PercentDone (event)

`Chilkat 11.7.0 · delphidll · ZipCrc · PercentDone · event`

```pascal
function MyPercentDone(pctDone: Integer): Integer; cdecl;
```

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The `pctDone` argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have `pctDone` equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an `AbortCheck` event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

Return `True` to abort; return `False` to continue (not abort)

### ZipCrc.ProgressInfo (event)

`Chilkat 11.7.0 · delphidll · ZipCrc · ProgressInfo · event`

```pascal
procedure MyProgressInfo(name: PWideChar; value: PWideChar) cdecl;
```

This event callback provides `tag name`/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

### ZipCrc.TaskCompleted (event)

`Chilkat 11.7.0 · delphidll · ZipCrc · TaskCompleted · event`

```pascal
procedure MyTaskCompleted(task: HCkTask) cdecl;
```

Called from the background thread when an asynchronous task completes.

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

```pascal
function CkZipCrc_FileCrcAsync(objHandle: HCkZipCrc;
    path: PWideChar): HCkTask; stdcall;
```

## 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/delphidll/classes/BinData.md), [`StringBuilder`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/classes/StringBuilder.md), [`Task`](https://www.chilkatsoft.com/ai-docs/v/11.7.0/delphidll/classes/Task.md)

