---
product: Chilkat
product_version: 11.7.0
language: sqlserver
language_label: SQL Server
class: ZipCrc
license: bundle
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/sqlserver_ZipCrcRef.html
---
# Chilkat ZipCrc — SQL Server — v11.7.0

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

**Object Creation**

```sql
DECLARE @hr int
DECLARE @zipCrc int
EXEC @hr = sp_OACreate 'Chilkat.ZipCrc', @zipCrc OUT
IF @hr <> 0
BEGIN
    PRINT 'Failed to create ActiveX component'
    RETURN
END

-- ... use @zipCrc ...

EXEC @hr = sp_OADestroy @zipCrc
```

T-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (`EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;`), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as `sp_OACreate 'Chilkat.ZipCrc.11'` for Chilkat v11.\*.\*.

`sp_OACreate` returns an object token (an `int`) that is passed as the first argument of every `sp_OAMethod`, `sp_OAGetProperty` and `sp_OASetProperty` call, and released with `sp_OADestroy`. Objects returned by methods (such as an `HttpResponse` or `JsonObject`) are also tokens received through an `int` OUT parameter; they must likewise be destroyed, and the OUT parameter is `NULL` when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero `@hr`), `sp_OAGetErrorInfo` describes the error.

Data types: strings are `nvarchar(4000)`; integers, booleans (1 or 0) and object tokens are `int`; dates are `datetime`. In the signatures on this page, `@success`, `@iResult`, `@sResult` and the like are the OUT variables receiving a method's return value, `@iValue` / `@sValue` receive or supply a property value, and the remaining `@` variables are the method's arguments in order.

A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example `DECLARE @tmp TABLE (outputLine ntext)` followed by `INSERT INTO @tmp EXEC sp_OAGetProperty @zipCrc, 'LastErrorText'`. See [string length limitations for strings returned by sp_OAMethod calls](https://www.chilkatsoft.com/sql_server_nvarchar_max_limitation.asp).

Methods that pass or return raw byte arrays are not shown on this page, because `varbinary(max)` values cannot be exchanged through `sp_OAMethod` (see [varbinary(max) limitation](https://www.chilkatsoft.com/sql_server_varbinary_max_limitation.asp)). Use the `BinData`-based alternatives (methods ending in *Bd*) or the base64 / hex string-encoded variants instead. Binary *properties* (such as `LastBinaryResult`) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*\*Async*) methods and event callbacks are not available from SQL Server.

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 SQL Server.

How failure is reported depends on the method's return type and is stated in the note under each method below. In every case the diagnostic text is in the `LastErrorText` property of the object whose method was called.

## 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` | `EXEC sp_OAGetProperty @zipCrc, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @zipCrc, 'DebugLogFilePath', @sValue` | read/write | If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. |
| `LastBinaryResult` | `INSERT INTO @tmp EXEC sp_OAGetProperty @zipCrc, 'LastBinaryResult'` | read-only | This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. |
| `LastErrorHtml` | `EXEC sp_OAGetProperty @zipCrc, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @zipCrc, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @zipCrc, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @zipCrc, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @zipCrc, 'LastMethodSuccess', @iValue` | read/write | Indicates the success or failure of the most recent method call: `1` means success, `0` means failure. |
| `LastStringResult` | `EXEC sp_OAGetProperty @zipCrc, 'LastStringResult', @sValue OUT` | read-only | In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. |
| `LastStringResultLen` | `EXEC sp_OAGetProperty @zipCrc, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @zipCrc, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @zipCrc, 'VerboseLogging', @iValue` | read/write | If set to `1`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `EXEC sp_OAGetProperty @zipCrc, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `BeginStream` | method | `EXEC sp_OAMethod @zipCrc, 'BeginStream', NULL` |
| `CrcBd` | method | `EXEC sp_OAMethod @zipCrc, 'CrcBd', @iResult OUT, @bd` |
| `CrcSb` | method | `EXEC sp_OAMethod @zipCrc, 'CrcSb', @iResult OUT, @sb, @charset` |
| `CrcString` | method | `EXEC sp_OAMethod @zipCrc, 'CrcString', @iResult OUT, @str, @charset` |
| `EndStream` | method | `EXEC sp_OAMethod @zipCrc, 'EndStream', @iResult OUT` |
| `FileCrc` | method | `EXEC sp_OAMethod @zipCrc, 'FileCrc', @iResult OUT, @path` |
| `ToHex` | method | `EXEC sp_OAMethod @zipCrc, 'ToHex', @sResult OUT, @crc` |

## Methods

### ZipCrc.BeginStream

`Chilkat 11.7.0 · sqlserver · ZipCrc · BeginStream · method`

```sql
EXEC sp_OAMethod @zipCrc, 'BeginStream', NULL
```

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

```sql
EXEC sp_OAMethod @zipCrc, 'CrcBd', @iResult OUT, @bd
```

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

### ZipCrc.CrcSb

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

```sql
EXEC sp_OAMethod @zipCrc, 'CrcSb', @iResult OUT, @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.

### ZipCrc.CrcString

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

```sql
EXEC sp_OAMethod @zipCrc, 'CrcString', @iResult OUT, @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.

### ZipCrc.EndStream

`Chilkat 11.7.0 · sqlserver · ZipCrc · EndStream · method`

```sql
EXEC sp_OAMethod @zipCrc, 'EndStream', @iResult OUT
```

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

### ZipCrc.FileCrc

`Chilkat 11.7.0 · sqlserver · ZipCrc · FileCrc · method`

```sql
EXEC sp_OAMethod @zipCrc, 'FileCrc', @iResult OUT, @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.

### ZipCrc.ToHex

`Chilkat 11.7.0 · sqlserver · ZipCrc · ToHex · method`

```sql
EXEC sp_OAMethod @zipCrc, 'ToHex', @sResult OUT, @crc
```

Converts a 32-bit integer to a hex string.

Returns `NULL` on failure

## Events and callbacks

This binding has no event callbacks.

## Related classes

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

