BinData Node.js Reference Documentation

BinData

Current Version: 9.5.0.73

Container for binary data. Provides methods for getting, setting, appending, etc. in binary and string encoded formats.

Object Creation

var obj = new chilkat.BinData();

Properties

LastMethodSuccess
LastMethodSuccess
· boolean

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumBytes
NumBytes
· integer, read-only
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top

Methods

AppendBd
var status = AppendBd(binData);
· Returns Boolean (true for success, false for failure).
· binDatabool
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns true for success, false for failure.

top
AppendBinary
var status = AppendBinary(data);
· Returns Boolean (true for success, false for failure).
· data Buffer
Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns true for success, false for failure.

top
AppendBom
var status = AppendBom(charset);
· Returns Boolean (true for success, false for failure).
· charset String
Introduced in version 9.5.0.62

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.

More Information and Examples
top
AppendEncoded
var status = AppendEncoded(encData, encoding);
· Returns Boolean (true for success, false for failure).
· encData String
· encoding String
Introduced in version 9.5.0.51

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.

Returns true for success, false for failure.

top
AppendEncodedSb
var status = AppendEncodedSb(sb, encoding);
· Returns Boolean (true for success, false for failure).
· sbbool
· encoding String
Introduced in version 9.5.0.62

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.

Returns true for success, false for failure.

top
AppendSb
var status = AppendSb(sb, charset);
· Returns Boolean (true for success, false for failure).
· sbbool
· charset String
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns true for success, false for failure.

More Information and Examples
top
AppendString
var status = AppendString(str, charset);
· Returns Boolean (true for success, false for failure).
· str String
· charset String
Introduced in version 9.5.0.62

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.

More Information and Examples
top
Clear
var status = Clear();
· Returns Boolean (true for success, false for failure).
Introduced in version 9.5.0.51

Clears the contents.

Returns true for success, false for failure.

top
ContentsEqual
var retBool = ContentsEqual(binData);
· Returns a Boolean.
· binDatabool
Introduced in version 9.5.0.62

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

top
GetBinary
var retBuf = GetBinary();
· Returns a Buffer.
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns null on failure

top
GetBinaryChunk
var retBuf = GetBinaryChunk(offset, numBytes);
· Returns a Buffer.
Introduced in version 9.5.0.51

Retrieves a chunk of the binary data contained within the object.

Returns null on failure

top
GetEncoded
var retStr = GetEncoded(encoding);
· Returns a String.
· encoding String
Introduced in version 9.5.0.51

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.

Returns null on failure

top
GetEncodedChunk
var retStr = GetEncodedChunk(offset, numBytes, encoding);
· Returns a String.
· offset Number
· numBytes Number
· encoding String
Introduced in version 9.5.0.51

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.

Returns null on failure

More Information and Examples
top
GetEncodedSb
var status = GetEncodedSb(encoding, sb);
· Returns Boolean (true for success, false for failure).
· encoding String
· sbbool
Introduced in version 9.5.0.64

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.

Returns true for success, false for failure.

More Information and Examples
top
GetString
var retStr = GetString(charset);
· Returns a String.
· charset String
Introduced in version 9.5.0.67

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

More Information and Examples
top
LoadBinary
var status = LoadBinary(data);
· Returns Boolean (true for success, false for failure).
· data Buffer
Introduced in version 9.5.0.51

Loads binary data and replaces the current contents, if any.

Returns true for success, false for failure.

top
LoadEncoded
var status = LoadEncoded(encData, encoding);
· Returns Boolean (true for success, false for failure).
· encData String
· encoding String
Introduced in version 9.5.0.51

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.

Returns true for success, false for failure.

top
LoadFile
var status = LoadFile(path);
· Returns Boolean (true for success, false for failure).
· path String
Introduced in version 9.5.0.51

Loads data from a file.

Returns true for success, false for failure.

top
RemoveChunk
var retBool = RemoveChunk(offset, numBytes);
· Returns a Boolean.
· offset Number
· numBytes Number
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
var status = SecureClear();
· Returns Boolean (true for success, false for failure).
Introduced in version 9.5.0.67

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

Returns true for success, false for failure.

top
WriteFile
var status = WriteFile(path);
· Returns Boolean (true for success, false for failure).
· path String
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns true for success, false for failure.

top