BinData ActiveX 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

(Visual Basic 6.0)
Dim obj As New ChilkatBinData

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.BinData")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.BinData")

(Delphi)
obj := TChilkatBinData.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.BinData')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.BinData")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.BinData', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.BinData");

Properties

LastMethodSuccess
LastMethodSuccess As Long

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumBytes
NumBytes As Long (read-only)
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top

Methods

AppendBd
AppendBd(binData As ChilkatBinData) As Long
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns 1 for success, 0 for failure.

top
AppendBinary
AppendBinary(data As Variant) As Long
Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns 1 for success, 0 for failure.

top
AppendBom
AppendBom(charset As String) As Long
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 1 for success, 0 for failure.

top
AppendEncoded
AppendEncoded(encData As String, encoding As String) As Long
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 1 for success, 0 for failure.

top
AppendEncodedSb
AppendEncodedSb(sb As ChilkatStringBuilder, encoding As String) As Long
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 1 for success, 0 for failure.

top
AppendSb
AppendSb(sb As ChilkatStringBuilder, charset As String) As Long
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns 1 for success, 0 for failure.

top
AppendString
AppendString(str As String, charset As String) As Long
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 1 for success, 0 for failure.

top
Clear
Clear() As Long
Introduced in version 9.5.0.51

Clears the contents.

Returns 1 for success, 0 for failure.

top
ContentsEqual
ContentsEqual(binData As ChilkatBinData) As Long
Introduced in version 9.5.0.62

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

top
GetBinary
GetBinary() As Variant
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

top
GetBinaryChunk
GetBinaryChunk(ByVal offset As Long, ByVal numBytes As Long) As Variant
Introduced in version 9.5.0.51

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

Returns a zero-length byte array (as a Variant) on failure.
An empty array will have a UBound of -1 meaning 0 elements.

top
GetEncoded
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 Nothing on failure

top
GetEncodedChunk
GetEncodedChunk(ByVal offset As Long, ByVal numBytes As Long, 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 Nothing on failure

top
GetEncodedSb
GetEncodedSb(encoding As String, sb As ChilkatStringBuilder) As Long
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 1 for success, 0 for failure.

top
GetString
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 Nothing on failure

More Information and Examples
top
LoadBinary
LoadBinary(data As Variant) As Long
Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

top
LoadEncoded
LoadEncoded(encData As String, encoding As String) As Long
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 1 for success, 0 for failure.

top
LoadFile
LoadFile(path As String) As Long
Introduced in version 9.5.0.51

Loads data from a file.

Returns 1 for success, 0 for failure.

top
RemoveChunk
RemoveChunk(ByVal offset As Long, ByVal numBytes As Long) As Long
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

top
SecureClear
SecureClear() As Long
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 1 for success, 0 for failure.

top
WriteFile
WriteFile(path As String) As Long
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns 1 for success, 0 for failure.

top