BinData Xojo Plugin Reference Documentation

BinData

Current Version: 9.5.0.88

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

Object Creation

Dim binData As New Chilkat.BinData

Properties

LastMethodSuccess
LastMethodSuccess As 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 As Int32 (read-only)
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top

Methods

AppendBd
Function AppendBd(binData As Chilkat.BinData) As Boolean
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
Function AppendBinary(data As MemoryBlock) As Boolean
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
Function AppendBom(charset As String) As Boolean
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
AppendByte
Function AppendByte(byteValue As Int32) As Boolean
Introduced in version 9.5.0.77

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

Returns True for success, False for failure.

top
AppendEncoded
Function AppendEncoded(encData As String, encoding As String) As Boolean
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
Function AppendEncodedSb(sb As Chilkat.StringBuilder, encoding As String) As Boolean
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
AppendInt2
Function AppendInt2(value As Int32, littleEndian As Boolean) As Boolean
Introduced in version 9.5.0.77

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.

More Information and Examples
top
AppendInt4
Function AppendInt4(value As Int32, littleEndian As Boolean) As Boolean
Introduced in version 9.5.0.77

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.

More Information and Examples
top
AppendPadded
Function AppendPadded(str As String, charset As String, padWithSpace As Boolean, fieldLen As Int32) As Boolean
Introduced in version 9.5.0.80

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.

top
AppendSb
Function AppendSb(sb As Chilkat.StringBuilder, charset As String) As Boolean
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
Function AppendString(str As String, charset As String) As Boolean
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
Function Clear() As Boolean
Introduced in version 9.5.0.51

Clears the contents.

Returns True for success, False for failure.

top
ContentsEqual
Function ContentsEqual(binData As Chilkat.BinData) As Boolean
Introduced in version 9.5.0.62

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

top
FindString
Function FindString(str As String, startIdx As Int32, charset As String) As Int32
Introduced in version 9.5.0.85

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.

top
GetBinary
Function GetBinary() As MemoryBlock
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns Nil on failure

top
GetBinaryChunk
Function GetBinaryChunk(offset As Int32, numBytes As Int32) As MemoryBlock
Introduced in version 9.5.0.51

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

Returns Nil on failure

top
GetEncoded
Function GetEncoded(encoding As String) As 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 Nil on failure

top
GetEncodedChunk
Function GetEncodedChunk(offset As Int32, numBytes As Int32, encoding As String) As 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 Nil on failure

More Information and Examples
top
GetEncodedSb
Function GetEncodedSb(encoding As String, sb As Chilkat.StringBuilder) As Boolean
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.

top
GetInt2
Function GetInt2(index As Int32, littleEndian As Boolean) As Int32
Introduced in version 9.5.0.88

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

top
GetInt4
Function GetInt4(index As Int32, littleEndian As Boolean) As Int32
Introduced in version 9.5.0.88

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

top
GetString
Function GetString(charset As String) As 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 Nil on failure

More Information and Examples
top
GetTextChunk
Function GetTextChunk(startIdx As Int32, numBytes As Int32, charset As String) As String
Introduced in version 9.5.0.85

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

Returns Nil on failure

top
GetUInt2
Function GetUInt2(index As Int32, littleEndian As Boolean) As UInt32
Introduced in version 9.5.0.88

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

top
GetUInt4
Function GetUInt4(index As Int32, littleEndian As Boolean) As UInt32
Introduced in version 9.5.0.88

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

top
LoadBinary
Function LoadBinary(data As MemoryBlock) As Boolean
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
Function LoadEncoded(encData As String, encoding As String) As Boolean
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
Function LoadFile(path As String) As Boolean
Introduced in version 9.5.0.51

Loads data from a file.

Returns True for success, False for failure.

top
RemoveChunk
Function RemoveChunk(offset As Int32, numBytes As Int32) As Boolean
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
Function SecureClear() As Boolean
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
Function WriteFile(path As String) As Boolean
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns True for success, False for failure.

top