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

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

## Purpose

**Build, transform, encode, decode, inspect, and save binary data.**

`Chilkat.BinData` is a general-purpose mutable byte container used throughout Chilkat for working with binary content in memory. It can load bytes from files, byte arrays, strings, and encoded text; append additional data in many forms; retrieve content as raw bytes, chunks, text, or encoded strings; compute hashes; convert character encodings; validate UTF-8; remove byte ranges; and write the final result to files.

**Load binary content**

Load data from files, byte arrays, strings, encoded strings, or other Chilkat objects that produce binary output.

**Append and build data**

Append bytes, strings, integers, BOMs, counted strings, padded fields, encoded data, and other `BinData` objects.

**Encode and decode**

Convert binary data to and from text encodings such as Base64, hex, URL encoding, and other supported binary encodings.

**Text and charset handling**

Interpret bytes as text, append strings using a specified charset, convert character encodings, and validate UTF-8 content.

**Inspect and modify bytes**

Get byte counts, extract chunks, remove ranges, compare data, and work with specific portions of a binary buffer.

**Hash and save output**

Compute hashes for the contained data and write the resulting bytes to files or pass them to other Chilkat classes.

**Common pattern:** Load or append binary data, perform any needed encoding, decoding, hashing, charset conversion, or byte-level edits, then retrieve the result as bytes, text, an encoded string, or a file. Use `BinData` whenever a Chilkat method needs a mutable in-memory binary buffer.

For an extended overview, see [BinData Class Overview](https://www.chilkatsoft.com/bindata_class_overview.asp).

## Object creation, unlocking and error handling

**Object Creation**

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

-- ... use @binData ...

EXEC @hr = sp_OADestroy @binData
```

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.BinData.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 @binData, '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 @binData, 'DebugLogFilePath', @sValue OUT EXEC sp_OASetProperty @binData, '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 @binData, '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 @binData, 'LastErrorHtml', @sValue OUT` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `EXEC sp_OAGetProperty @binData, 'LastErrorText', @sValue OUT` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `EXEC sp_OAGetProperty @binData, 'LastErrorXml', @sValue OUT` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `EXEC sp_OAGetProperty @binData, 'LastMethodSuccess', @iValue OUT EXEC sp_OASetProperty @binData, '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 @binData, '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 @binData, 'LastStringResultLen', @iValue OUT` | read-only | The length, in characters, of the string contained in the LastStringResult property. |
| `VerboseLogging` | `EXEC sp_OAGetProperty @binData, 'VerboseLogging', @iValue OUT EXEC sp_OASetProperty @binData, '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 @binData, 'Version', @sValue OUT` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumBytes` | property, read-only | `EXEC sp_OAGetProperty @binData, 'NumBytes', @iValue OUT` |
| `AppendBd` | method | `EXEC sp_OAMethod @binData, 'AppendBd', @success OUT, @binData` |
| `AppendBom` | method | `EXEC sp_OAMethod @binData, 'AppendBom', @success OUT, @charset` |
| `AppendByte` | method | `EXEC sp_OAMethod @binData, 'AppendByte', @success OUT, @byteValue` |
| `AppendCountedString` | method | `EXEC sp_OAMethod @binData, 'AppendCountedString', @success OUT, @numCountBytes, @bigEndian, @str, @charset` |
| `AppendEncoded` | method | `EXEC sp_OAMethod @binData, 'AppendEncoded', @success OUT, @encData, @encoding` |
| `AppendEncodedSb` | method | `EXEC sp_OAMethod @binData, 'AppendEncodedSb', @success OUT, @sb, @encoding` |
| `AppendInt2` | method | `EXEC sp_OAMethod @binData, 'AppendInt2', @success OUT, @value, @littleEndian` |
| `AppendInt4` | method | `EXEC sp_OAMethod @binData, 'AppendInt4', @success OUT, @value, @littleEndian` |
| `AppendPadded` | method | `EXEC sp_OAMethod @binData, 'AppendPadded', @success OUT, @str, @charset, @padWithSpace, @fieldLen` |
| `AppendSb` | method | `EXEC sp_OAMethod @binData, 'AppendSb', @success OUT, @sb, @charset` |
| `AppendString` | method | `EXEC sp_OAMethod @binData, 'AppendString', @success OUT, @str, @charset` |
| `ByteSwap` | method | `EXEC sp_OAMethod @binData, 'ByteSwap', NULL, @size` |
| `CharsetConvert` | method | `EXEC sp_OAMethod @binData, 'CharsetConvert', @success OUT, @fromCharset, @toCharset, @allOrNone` |
| `Clear` | method | `EXEC sp_OAMethod @binData, 'Clear', @success OUT` |
| `ContentsEqual` | method | `EXEC sp_OAMethod @binData, 'ContentsEqual', @success OUT, @binData` |
| `FindString` | method | `EXEC sp_OAMethod @binData, 'FindString', @iResult OUT, @str, @startIdx, @charset` |
| `GetByte` | method | `EXEC sp_OAMethod @binData, 'GetByte', @iResult OUT, @index` |
| `GetEncoded` | method | `EXEC sp_OAMethod @binData, 'GetEncoded', @sResult OUT, @encoding` |
| `GetEncodedChunk` | method | `EXEC sp_OAMethod @binData, 'GetEncodedChunk', @sResult OUT, @offset, @numBytes, @encoding` |
| `GetEncodedSb` | method | `EXEC sp_OAMethod @binData, 'GetEncodedSb', @success OUT, @encoding, @sb` |
| `GetHash` | method | `EXEC sp_OAMethod @binData, 'GetHash', @sResult OUT, @algorithm, @encoding` |
| `GetInt2` | method | `EXEC sp_OAMethod @binData, 'GetInt2', @iResult OUT, @index, @littleEndian` |
| `GetInt4` | method | `EXEC sp_OAMethod @binData, 'GetInt4', @iResult OUT, @index, @littleEndian` |
| `GetString` | method | `EXEC sp_OAMethod @binData, 'GetString', @sResult OUT, @charset` |
| `GetTextChunk` | method | `EXEC sp_OAMethod @binData, 'GetTextChunk', @sResult OUT, @startIdx, @numBytes, @charset` |
| `IsValidUtf8` | method | `EXEC sp_OAMethod @binData, 'IsValidUtf8', @success OUT` |
| `LoadEncoded` | method | `EXEC sp_OAMethod @binData, 'LoadEncoded', @success OUT, @encData, @encoding` |
| `LoadFile` | method | `EXEC sp_OAMethod @binData, 'LoadFile', @success OUT, @path` |
| `RemoveByteVal` | method | `EXEC sp_OAMethod @binData, 'RemoveByteVal', NULL, @value` |
| `RemoveChunk` | method | `EXEC sp_OAMethod @binData, 'RemoveChunk', @success OUT, @offset, @numBytes` |
| `SecureClear` | method | `EXEC sp_OAMethod @binData, 'SecureClear', @success OUT` |
| `WriteAppendFile` | method | `EXEC sp_OAMethod @binData, 'WriteAppendFile', @success OUT, @path` |
| `WriteFile` | method | `EXEC sp_OAMethod @binData, 'WriteFile', @success OUT, @path` |

## Properties

### BinData.NumBytes

`Chilkat 11.7.0 · sqlserver · BinData · NumBytes · property · read-only · since 9.5.0.51`

```sql
EXEC sp_OAGetProperty @binData, 'NumBytes', @iValue OUT
```

The number of bytes contained within the object.

## Methods

### BinData.AppendBd

`Chilkat 11.7.0 · sqlserver · BinData · AppendBd · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @binData, 'AppendBd', @success OUT, @binData
```

Appends the contents of another BinData to this object.

Returns 1 for success, 0 for failure.

### BinData.AppendBom

`Chilkat 11.7.0 · sqlserver · BinData · AppendBom · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @binData, 'AppendBom', @success OUT, @charset
```

Appends the appropriate BOM (byte order mark), also known as a `preamble`, for the given charset. If the `charset` has no defined BOM, then nothing is appended. An application would typically call this to append the utf-8, utf-16, or utf-32 BOM.

Returns 1 for success, 0 for failure.

### BinData.AppendByte

`Chilkat 11.7.0 · sqlserver · BinData · AppendByte · method · since 9.5.0.77`

```sql
EXEC sp_OAMethod @binData, 'AppendByte', @success OUT, @byteValue
```

Appends a single byte. The `byteValue` should be a value from 0 to 255.

Returns 1 for success, 0 for failure.

### BinData.AppendCountedString

`Chilkat 11.7.0 · sqlserver · BinData · AppendCountedString · method · since 9.5.0.91`

```sql
EXEC sp_OAMethod @binData, 'AppendCountedString', @success OUT, @numCountBytes, @bigEndian, @str, @charset
```

Appends a byte count followed by the string in the desired character encoding, such as `utf-8`. The `numCountBytes` is the size in bytes of the integer to represent the byte count. If 0, then a minimal number of bytes is used. If `bigEndian` is `1`, the byte count is appended in big endian byte ordering, otherwise little-ending byte ordering. The `str` is the string to be appended. The `charset` is the character encoding, such as `utf-8`, `utf-16`, `windows-1252`, etc.

Returns 1 for success, 0 for failure.

### BinData.AppendEncoded

`Chilkat 11.7.0 · sqlserver · BinData · AppendEncoded · method · since 9.5.0.51`

```sql
EXEC sp_OAMethod @binData, 'AppendEncoded', @success OUT, @encData, @encoding
```

Appends encoded binary data to the current data. The `encoding` may be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

Returns 1 for success, 0 for failure.

### BinData.AppendEncodedSb

`Chilkat 11.7.0 · sqlserver · BinData · AppendEncodedSb · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @binData, 'AppendEncodedSb', @success OUT, @sb, @encoding
```

Decodes the contents of `sb` and appends the decoded bytes to this object. The `encoding` may be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

Returns 1 for success, 0 for failure.

### BinData.AppendInt2

`Chilkat 11.7.0 · sqlserver · BinData · AppendInt2 · method · since 9.5.0.77`

```sql
EXEC sp_OAMethod @binData, 'AppendInt2', @success OUT, @value, @littleEndian
```

Appends a 16-bit integer (2 bytes). If `littleEndian` is `1`, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns 1 for success, 0 for failure.

### BinData.AppendInt4

`Chilkat 11.7.0 · sqlserver · BinData · AppendInt4 · method · since 9.5.0.77`

```sql
EXEC sp_OAMethod @binData, 'AppendInt4', @success OUT, @value, @littleEndian
```

Appends a 32-bit integer (4 bytes). If `littleEndian` is `1`, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns 1 for success, 0 for failure.

### BinData.AppendPadded

`Chilkat 11.7.0 · sqlserver · BinData · AppendPadded · method · since 9.5.0.80`

```sql
EXEC sp_OAMethod @binData, 'AppendPadded', @success OUT, @str, @charset, @padWithSpace, @fieldLen
```

Appends a string to this object, padded to the `fieldLen` with NULL or SPACE chars. If `padWithSpace` is `1`, then SPACE chars are used and the string is not null-terminated. If `fieldLen` is `0`, then null bytes are used. The `charset` controls the byte representation to use, such as `utf-8`.

Note: This call will always append a total number of bytes equal to `fieldLen`. If the `str` is longer than `fieldLen`, the method returns `0` to indicate failure and nothing is appended.

Returns 1 for success, 0 for failure.

### BinData.AppendSb

`Chilkat 11.7.0 · sqlserver · BinData · AppendSb · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @binData, 'AppendSb', @success OUT, @sb, @charset
```

Appends the contents of a StringBuilder to this object.

Returns 1 for success, 0 for failure.

### BinData.AppendString

`Chilkat 11.7.0 · sqlserver · BinData · AppendString · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @binData, 'AppendString', @success OUT, @str, @charset
```

Appends a string to this object. (This does not append the BOM. If a BOM is required, the AppendBom method can be called to append the appropriate BOM.)

Returns 1 for success, 0 for failure.

### BinData.ByteSwap

`Chilkat 11.7.0 · sqlserver · BinData · ByteSwap · method · since 11.0.0`

```sql
EXEC sp_OAMethod @binData, 'ByteSwap', NULL, @size
```

Does either 16-bit or 32-bit byte swapping of the entire contents. If `size` equals 16, then swaps in 2 bytes (e.g., 0x1234 → 0x3412). If `size` equals 32, then swaps 4 bytes (e.g., 0x12345678 → 0x78563412)

### BinData.CharsetConvert

`Chilkat 11.7.0 · sqlserver · BinData · CharsetConvert · method · since 11.0.0`

```sql
EXEC sp_OAMethod @binData, 'CharsetConvert', @success OUT, @fromCharset, @toCharset, @allOrNone
```

This method converts the character encoding of an object's contents from one format to another, such as from Windows-1252 to UTF-8. The `allOrNone` parameter determines error handling for unrepresentable bytes. If `allOrNone` is `1`, the object's contents remain unchanged when errors occur. If `0`, error bytes are discarded. The method returns `1` if successful and `0` if errors occur.

Returns 1 for success, 0 for failure.

### BinData.Clear

`Chilkat 11.7.0 · sqlserver · BinData · Clear · method · since 9.5.0.51`

```sql
EXEC sp_OAMethod @binData, 'Clear', @success OUT
```

Clears the contents.

Returns 1 for success, 0 for failure.

### BinData.ContentsEqual

`Chilkat 11.7.0 · sqlserver · BinData · ContentsEqual · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @binData, 'ContentsEqual', @success OUT, @binData
```

Return `1` if the contents of this object equals the contents of `binData`.

### BinData.FindString

`Chilkat 11.7.0 · sqlserver · BinData · FindString · method · since 9.5.0.85`

```sql
EXEC sp_OAMethod @binData, 'FindString', @iResult OUT, @str, @startIdx, @charset
```

Return the index where the first occurrence of `str` is found. Return -1 if not found. The `startIdx` indicates the byte index where the search begins. The `charset` specifies the byte representation of `str` that is to be searched. For example, it can be `utf-8`, `windows-1252`, `ansi`, `utf-16`, etc.

### BinData.GetByte

`Chilkat 11.7.0 · sqlserver · BinData · GetByte · method · since 9.5.0.92`

```sql
EXEC sp_OAMethod @binData, 'GetByte', @iResult OUT, @index
```

Returns the value of the byte at the given `index`. The returned value is an integer from 0 to 255.

### BinData.GetEncoded

`Chilkat 11.7.0 · sqlserver · BinData · GetEncoded · method · since 9.5.0.51`

```sql
EXEC sp_OAMethod @binData, 'GetEncoded', @sResult OUT, @encoding
```

Retrieves the binary data as an encoded string. The `encoding` may be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

Returns `NULL` on failure

### BinData.GetEncodedChunk

`Chilkat 11.7.0 · sqlserver · BinData · GetEncodedChunk · method · since 9.5.0.51`

```sql
EXEC sp_OAMethod @binData, 'GetEncodedChunk', @sResult OUT, @offset, @numBytes, @encoding
```

Retrieves a chunk of the binary data and returns it in encoded form. The `encoding` may be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

Returns `NULL` on failure

### BinData.GetEncodedSb

`Chilkat 11.7.0 · sqlserver · BinData · GetEncodedSb · method · since 9.5.0.64`

```sql
EXEC sp_OAMethod @binData, 'GetEncodedSb', @success OUT, @encoding, @sb
```

Writes the encoded data to a StringBuilder. The `encoding` may be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

Returns 1 for success, 0 for failure.

### BinData.GetHash

`Chilkat 11.7.0 · sqlserver · BinData · GetHash · method · since 9.5.0.91`

```sql
EXEC sp_OAMethod @binData, 'GetHash', @sResult OUT, @algorithm, @encoding
```

Returns the hash of the contents of this object. The `algorithm` is the hash algorithm, and can be `sha1`, `sha256`, `sha384`, `sha512`, `sha3-224`, `sha3-256`, `sha3-384`, `sha3-512`, `md2`, `md5`, `ripemd128`, `ripemd160`,`ripemd256`, or `ripemd320`. The `encoding` can be `base64`, `modBase64`, `base64Url`, `base32`, `base58`, `qp` (for quoted-printable), `url` (for url-encoding), `hex`, `hexLower`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

Returns `NULL` on failure

### BinData.GetInt2

`Chilkat 11.7.0 · sqlserver · BinData · GetInt2 · method · since 9.5.0.88`

```sql
EXEC sp_OAMethod @binData, 'GetInt2', @iResult OUT, @index, @littleEndian
```

Returns the value of the 16-bit signed integer stored in big-endian or little-endian byte ordering at the given index.

### BinData.GetInt4

`Chilkat 11.7.0 · sqlserver · BinData · GetInt4 · method · since 9.5.0.88`

```sql
EXEC sp_OAMethod @binData, 'GetInt4', @iResult OUT, @index, @littleEndian
```

Returns the value of the 32-bit signed integer stored in big-endian or little-endian byte ordering at the given index.

### BinData.GetString

`Chilkat 11.7.0 · sqlserver · BinData · GetString · method · since 9.5.0.67`

```sql
EXEC sp_OAMethod @binData, 'GetString', @sResult OUT, @charset
```

Interprets the bytes according to `charset` and returns the string. The `charset` can be `utf-8`, `utf-16`, `ansi`, `iso-8859-*`, `windows-125*`, or any of the supported character encodings listed in the link below.

Returns `NULL` on failure

See also:

- [Chilkat Supported Character Encodings](http://cknotes.com/chilkat-charsets-character-encodings-supported/)

### BinData.GetTextChunk

`Chilkat 11.7.0 · sqlserver · BinData · GetTextChunk · method · since 9.5.0.85`

```sql
EXEC sp_OAMethod @binData, 'GetTextChunk', @sResult OUT, @startIdx, @numBytes, @charset
```

Returns `numBytes` bytes starting at `startIdx`. The bytes are interpreted according to `charset` (for example, `utf-8`, `ansi`, `utf-16`, `windows-1252`, etc.)

Returns `NULL` on failure

### BinData.IsValidUtf8

`Chilkat 11.7.0 · sqlserver · BinData · IsValidUtf8 · method · since 10.1.0`

```sql
EXEC sp_OAMethod @binData, 'IsValidUtf8', @success OUT
```

Returns `1` if this object contains valid utf-8 byte sequences. Any invalid byte sequence that is not valid utf-8 will cause this function to return `0`.

Returns 1 for success, 0 for failure.

### BinData.LoadEncoded

`Chilkat 11.7.0 · sqlserver · BinData · LoadEncoded · method · since 9.5.0.51`

```sql
EXEC sp_OAMethod @binData, 'LoadEncoded', @success OUT, @encData, @encoding
```

Loads binary data from an encoded string, replacing the current contents, if any. The `encoding` may be `Base64`, `modBase64`, `base64Url`, `Base32`, `Base58`, `QP` (for quoted-printable), `URL` (for url-encoding), `Hex`, or any of the encodings found at [Chilkat Binary Encodings List](https://www.chilkatsoft.com/binary_encodings.asp).

Returns 1 for success, 0 for failure.

### BinData.LoadFile

`Chilkat 11.7.0 · sqlserver · BinData · LoadFile · method · since 9.5.0.51`

```sql
EXEC sp_OAMethod @binData, 'LoadFile', @success OUT, @path
```

Loads data from a file.

Returns 1 for success, 0 for failure.

### BinData.RemoveByteVal

`Chilkat 11.7.0 · sqlserver · BinData · RemoveByteVal · method · since 9.5.0.90`

```sql
EXEC sp_OAMethod @binData, 'RemoveByteVal', NULL, @value
```

Removes bytes having a specified value (0-255). For example, to remove all null bytes, pass 0 in `value`.

### BinData.RemoveChunk

`Chilkat 11.7.0 · sqlserver · BinData · RemoveChunk · method · since 9.5.0.51`

```sql
EXEC sp_OAMethod @binData, 'RemoveChunk', @success OUT, @offset, @numBytes
```

Removes a chunk of bytes from the binary data.

Returns 1 for success, 0 for failure.

### BinData.SecureClear

`Chilkat 11.7.0 · sqlserver · BinData · SecureClear · method · since 9.5.0.67`

```sql
EXEC sp_OAMethod @binData, 'SecureClear', @success OUT
```

Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.

Returns 1 for success, 0 for failure.

### BinData.WriteAppendFile

`Chilkat 11.7.0 · sqlserver · BinData · WriteAppendFile · method · since 9.5.0.91`

```sql
EXEC sp_OAMethod @binData, 'WriteAppendFile', @success OUT, @path
```

Appends the contents of this object to a file.

Returns 1 for success, 0 for failure.

### BinData.WriteFile

`Chilkat 11.7.0 · sqlserver · BinData · WriteFile · method · since 9.5.0.62`

```sql
EXEC sp_OAMethod @binData, 'WriteFile', @success OUT, @path
```

Writes the contents to a file.

Returns 1 for success, 0 for failure.

## Related classes

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

