---
product: Chilkat
product_version: 11.7.0
language: js
language_label: JavaScript
class: BinData
license: free
deprecated: false
reference_html: https://www.chilkatsoft.com/refdoc/jsBinDataRef.html
---
# Chilkat BinData — JavaScript — v11.7.0

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

Note: This is intended for running within a [Chilkat.Js embedded JavaScript engine](https://www.chilkatsoft.com/chilkat_javascript_engine.asp).

```
var obj = new CkBinData();
```

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

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` | `DebugLogFilePath` | 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` | `LastErrorHtml` | read-only | Provides HTML-formatted information about the last called method or property. |
| `LastErrorText` | `LastErrorText` | read-only | Provides plain text information about the last called method or property. |
| `LastErrorXml` | `LastErrorXml` | read-only | Provides XML-formatted information about the last called method or property. |
| `LastMethodSuccess` | `LastMethodSuccess` | read/write | Indicates the success or failure of the most recent method call: `true` means success, `false` means failure. |
| `VerboseLogging` | `VerboseLogging` | read/write | If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. |
| `Version` | `Version` | read-only | Version of the component/library, such as "10.1.0" |

## Member index

| Member | Kind | Signature |
|---|---|---|
| `NumBytes` | property, read-only | `NumBytes` |
| `AppendBd` | method | `var success = AppendBd(binData);` |
| `AppendBom` | method | `var success = AppendBom(charset);` |
| `AppendByte` | method | `var success = AppendByte(byteValue);` |
| `AppendCountedString` | method | `var success = AppendCountedString(numCountBytes, bigEndian, str, charset);` |
| `AppendEncoded` | method | `var success = AppendEncoded(encData, encoding);` |
| `AppendEncodedSb` | method | `var success = AppendEncodedSb(sb, encoding);` |
| `AppendInt2` | method | `var success = AppendInt2(value, littleEndian);` |
| `AppendInt4` | method | `var success = AppendInt4(value, littleEndian);` |
| `AppendPadded` | method | `var success = AppendPadded(str, charset, padWithSpace, fieldLen);` |
| `AppendSb` | method | `var success = AppendSb(sb, charset);` |
| `AppendString` | method | `var success = AppendString(str, charset);` |
| `ByteSwap` | method | `ByteSwap(size);` |
| `CharsetConvert` | method | `var success = CharsetConvert(fromCharset, toCharset, allOrNone);` |
| `Clear` | method | `var success = Clear();` |
| `ContentsEqual` | method | `var boolVal = ContentsEqual(binData);` |
| `FindString` | method | `var intVal = FindString(str, startIdx, charset);` |
| `GetByte` | method | `var intVal = GetByte(index);` |
| `GetEncoded` | method | `var strVal = GetEncoded(encoding);` |
| `GetEncodedChunk` | method | `var strVal = GetEncodedChunk(offset, numBytes, encoding);` |
| `GetEncodedSb` | method | `var success = GetEncodedSb(encoding, sb);` |
| `GetHash` | method | `var strVal = GetHash(algorithm, encoding);` |
| `GetInt2` | method | `var intVal = GetInt2(index, littleEndian);` |
| `GetInt4` | method | `var intVal = GetInt4(index, littleEndian);` |
| `GetString` | method | `var strVal = GetString(charset);` |
| `GetTextChunk` | method | `var strVal = GetTextChunk(startIdx, numBytes, charset);` |
| `GetUInt2` | method | `var uintVal = GetUInt2(index, littleEndian);` |
| `GetUInt4` | method | `var uintVal = GetUInt4(index, littleEndian);` |
| `IsValidUtf8` | method | `var success = IsValidUtf8();` |
| `LoadEncoded` | method | `var success = LoadEncoded(encData, encoding);` |
| `LoadFile` | method | `var success = LoadFile(path);` |
| `RemoveByteVal` | method | `RemoveByteVal(value);` |
| `RemoveChunk` | method | `var success = RemoveChunk(offset, numBytes);` |
| `SecureClear` | method | `var success = SecureClear();` |
| `WriteAppendFile` | method | `var success = WriteAppendFile(path);` |
| `WriteFile` | method | `var success = WriteFile(path);` |

## Properties

### BinData.NumBytes

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

```javascript
NumBytes
```

· `int`, `read-only`

The number of bytes contained within the object.

## Methods

### BinData.AppendBd

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

```javascript
var success = AppendBd(binData);
```

· return: `boolean`; `true` for success, `false` for failure  
· binData: `CkBinData`

Appends the contents of another BinData to this object.

Returns true for success, false for failure.

### BinData.AppendBom

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

```javascript
var success = AppendBom(charset);
```

· return: `boolean`; `true` for success, `false` for failure  
· charset: `string`

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 true for success, false for failure.

### BinData.AppendByte

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

```javascript
var success = AppendByte(byteValue);
```

· return: `boolean`; `true` for success, `false` for failure  
· byteValue: `int`

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

Returns true for success, false for failure.

### BinData.AppendCountedString

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

```javascript
var success = AppendCountedString(numCountBytes, bigEndian, str, charset);
```

· return: `boolean`; `true` for success, `false` for failure  
· numCountBytes: `int`  
· bigEndian: `boolean`  
· str: `string`  
· charset: `string`

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 `true`, 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 true for success, false for failure.

### BinData.AppendEncoded

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

```javascript
var success = AppendEncoded(encData, encoding);
```

· return: `boolean`; `true` for success, `false` for failure  
· encData: `string`  
· encoding: `string`

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 true for success, false for failure.

### BinData.AppendEncodedSb

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

```javascript
var success = AppendEncodedSb(sb, encoding);
```

· return: `boolean`; `true` for success, `false` for failure  
· sb: `CkStringBuilder`  
· encoding: `string`

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 true for success, false for failure.

### BinData.AppendInt2

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

```javascript
var success = AppendInt2(value, littleEndian);
```

· return: `boolean`; `true` for success, `false` for failure  
· value: `int`  
· littleEndian: `boolean`

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

Returns true for success, false for failure.

### BinData.AppendInt4

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

```javascript
var success = AppendInt4(value, littleEndian);
```

· return: `boolean`; `true` for success, `false` for failure  
· value: `int`  
· littleEndian: `boolean`

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

Returns true for success, false for failure.

### BinData.AppendPadded

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

```javascript
var success = AppendPadded(str, charset, padWithSpace, fieldLen);
```

· return: `boolean`; `true` for success, `false` for failure  
· str: `string`  
· charset: `string`  
· padWithSpace: `boolean`  
· fieldLen: `int`

Appends a string to this object, padded to the `fieldLen` with NULL or SPACE chars. If `padWithSpace` is `true`, then SPACE chars are used and the string is not null-terminated. If `fieldLen` is `false`, 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 `false` to indicate failure and nothing is appended.

Returns true for success, false for failure.

### BinData.AppendSb

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

```javascript
var success = AppendSb(sb, charset);
```

· return: `boolean`; `true` for success, `false` for failure  
· sb: `CkStringBuilder`  
· charset: `string`

Appends the contents of a StringBuilder to this object.

Returns true for success, false for failure.

### BinData.AppendString

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

```javascript
var success = AppendString(str, charset);
```

· return: `boolean`; `true` for success, `false` for failure  
· str: `string`  
· charset: `string`

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 true for success, false for failure.

### BinData.ByteSwap

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

```javascript
ByteSwap(size);
```

· return: `undefined`  
· size: `int`

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 · js · BinData · CharsetConvert · method · since 11.0.0`

```javascript
var success = CharsetConvert(fromCharset, toCharset, allOrNone);
```

· return: `boolean`; `true` for success, `false` for failure  
· fromCharset: `string`  
· toCharset: `string`  
· allOrNone: `boolean`

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 `true`, the object's contents remain unchanged when errors occur. If `false`, error bytes are discarded. The method returns `true` if successful and `false` if errors occur.

Returns true for success, false for failure.

### BinData.Clear

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

```javascript
var success = Clear();
```

· return: `boolean`; `true` for success, `false` for failure

Clears the contents.

Returns true for success, false for failure.

### BinData.ContentsEqual

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

```javascript
var boolVal = ContentsEqual(binData);
```

· return: `boolean`  
· binData: `CkBinData`

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

### BinData.FindString

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

```javascript
var intVal = FindString(str, startIdx, charset);
```

· return: `int`  
· str: `string`  
· startIdx: `int`  
· charset: `string`

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 · js · BinData · GetByte · method · since 9.5.0.92`

```javascript
var intVal = GetByte(index);
```

· return: `int`  
· index: `int`

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 · js · BinData · GetEncoded · method · since 9.5.0.51`

```javascript
var strVal = GetEncoded(encoding);
```

· return: `string`  
· encoding: `string`

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 · js · BinData · GetEncodedChunk · method · since 9.5.0.51`

```javascript
var strVal = GetEncodedChunk(offset, numBytes, encoding);
```

· return: `string`  
· offset: `int`  
· numBytes: `int`  
· encoding: `string`

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 · js · BinData · GetEncodedSb · method · since 9.5.0.64`

```javascript
var success = GetEncodedSb(encoding, sb);
```

· return: `boolean`; `true` for success, `false` for failure  
· encoding: `string`  
· sb: `CkStringBuilder`

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 true for success, false for failure.

### BinData.GetHash

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

```javascript
var strVal = GetHash(algorithm, encoding);
```

· return: `string`  
· algorithm: `string`  
· encoding: `string`

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 · js · BinData · GetInt2 · method · since 9.5.0.88`

```javascript
var intVal = GetInt2(index, littleEndian);
```

· return: `int`  
· index: `int`  
· littleEndian: `boolean`

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 · js · BinData · GetInt4 · method · since 9.5.0.88`

```javascript
var intVal = GetInt4(index, littleEndian);
```

· return: `int`  
· index: `int`  
· littleEndian: `boolean`

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 · js · BinData · GetString · method · since 9.5.0.67`

```javascript
var strVal = GetString(charset);
```

· return: `string`  
· charset: `string`

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 · js · BinData · GetTextChunk · method · since 9.5.0.85`

```javascript
var strVal = GetTextChunk(startIdx, numBytes, charset);
```

· return: `string`  
· startIdx: `int`  
· numBytes: `int`  
· charset: `string`

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

`Chilkat 11.7.0 · js · BinData · GetUInt2 · method · since 9.5.0.88`

```javascript
var uintVal = GetUInt2(index, littleEndian);
```

· return: `unsigned int`  
· index: `int`  
· littleEndian: `boolean`

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

### BinData.GetUInt4

`Chilkat 11.7.0 · js · BinData · GetUInt4 · method · since 9.5.0.88`

```javascript
var uintVal = GetUInt4(index, littleEndian);
```

· return: `unsigned int`  
· index: `int`  
· littleEndian: `boolean`

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

### BinData.IsValidUtf8

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

```javascript
var success = IsValidUtf8();
```

· return: `boolean`; `true` for success, `false` for failure

Returns `true` 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 `false`.

Returns true for success, false for failure.

### BinData.LoadEncoded

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

```javascript
var success = LoadEncoded(encData, encoding);
```

· return: `boolean`; `true` for success, `false` for failure  
· encData: `string`  
· encoding: `string`

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 true for success, false for failure.

### BinData.LoadFile

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

```javascript
var success = LoadFile(path);
```

· return: `boolean`; `true` for success, `false` for failure  
· path: `string`

Loads data from a file.

Returns true for success, false for failure.

### BinData.RemoveByteVal

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

```javascript
RemoveByteVal(value);
```

· return: `undefined`  
· value: `int`

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 · js · BinData · RemoveChunk · method · since 9.5.0.51`

```javascript
var success = RemoveChunk(offset, numBytes);
```

· return: `boolean`; `true` for success, `false` for failure  
· offset: `int`  
· numBytes: `int`

Removes a chunk of bytes from the binary data.

Returns true for success, false for failure.

### BinData.SecureClear

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

```javascript
var success = SecureClear();
```

· return: `boolean`; `true` for success, `false` for failure

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

Returns true for success, false for failure.

### BinData.WriteAppendFile

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

```javascript
var success = WriteAppendFile(path);
```

· return: `boolean`; `true` for success, `false` for failure  
· path: `string`

Appends the contents of this object to a file.

Returns true for success, false for failure.

### BinData.WriteFile

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

```javascript
var success = WriteFile(path);
```

· return: `boolean`; `true` for success, `false` for failure  
· path: `string`

Writes the contents to a file.

Returns true for success, false for failure.

## Related classes

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