BinData ActiveX Reference Documentation

BinData

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 As Long

Introduced in version 9.5.0.52

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.

NumBytes As Long (read-only)

Introduced in version 9.5.0.51

The number of bytes contained within the object.

Methods

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.

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.

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.

(Classic ASP) StringBuilder to Bytes (in BinData)

(Visual FoxPro) StringBuilder to Bytes (in BinData)

(PowerBuilder) StringBuilder to Bytes (in BinData)

(SQL Server) StringBuilder to Bytes (in BinData)

(Visual Basic 6.0) StringBuilder to Bytes (in BinData)

(VBScript) StringBuilder to Bytes (in BinData)

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.

(Classic ASP) Demonstrate Binary Data Encoding Methods

(Visual FoxPro) Demonstrate Binary Data Encoding Methods

(PowerBuilder) Demonstrate Binary Data Encoding Methods

(SQL Server) Demonstrate Binary Data Encoding Methods

(Visual Basic 6.0) Demonstrate Binary Data Encoding Methods

(VBScript) Demonstrate Binary Data Encoding Methods

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.

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.

(Classic ASP) StringBuilder to Bytes (in BinData)

(Visual FoxPro) StringBuilder to Bytes (in BinData)

(PowerBuilder) StringBuilder to Bytes (in BinData)

(SQL Server) StringBuilder to Bytes (in BinData)

(Visual Basic 6.0) StringBuilder to Bytes (in BinData)

(VBScript) StringBuilder to Bytes (in BinData)

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.

(Classic ASP) Appending Strings to BinData

(Visual FoxPro) Appending Strings to BinData

(PowerBuilder) Appending Strings to BinData

(SQL Server) Appending Strings to BinData

(Visual Basic 6.0) Appending Strings to BinData

(VBScript) Appending Strings to BinData

Clear() As Long

Introduced in version 9.5.0.51

Clears the contents.

Returns 1 for success, 0 for failure.

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.

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.

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.

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

(Classic ASP) Demonstrate Binary Data Encoding Methods

(Visual FoxPro) Demonstrate Binary Data Encoding Methods

(PowerBuilder) Demonstrate Binary Data Encoding Methods

(SQL Server) Demonstrate Binary Data Encoding Methods

(Visual Basic 6.0) Demonstrate Binary Data Encoding Methods

(VBScript) Demonstrate Binary Data Encoding Methods

(Classic ASP) Determine File Type from Binary Content of File

(Visual FoxPro) Determine File Type from Binary Content of File

(PowerBuilder) Determine File Type from Binary Content of File

(SQL Server) Determine File Type from Binary Content of File

(Visual Basic 6.0) Determine File Type from Binary Content of File

(VBScript) Determine File Type from Binary Content of File

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

(Classic ASP) Demonstrate Binary Data Encoding Methods

(Visual FoxPro) Demonstrate Binary Data Encoding Methods

(PowerBuilder) Demonstrate Binary Data Encoding Methods

(SQL Server) Demonstrate Binary Data Encoding Methods

(Visual Basic 6.0) Demonstrate Binary Data Encoding Methods

(VBScript) Demonstrate Binary Data Encoding Methods

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.

(Classic ASP) Demonstrate Binary Data Encoding Methods

(Visual FoxPro) Demonstrate Binary Data Encoding Methods

(PowerBuilder) Demonstrate Binary Data Encoding Methods

(SQL Server) Demonstrate Binary Data Encoding Methods

(Visual Basic 6.0) Demonstrate Binary Data Encoding Methods

(VBScript) Demonstrate Binary Data Encoding Methods

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

Chilkat Supported Character Encodings

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.

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.

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.

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.

(Classic ASP) Demonstrate Binary Data Encoding Methods

(Visual FoxPro) Demonstrate Binary Data Encoding Methods

(PowerBuilder) Demonstrate Binary Data Encoding Methods

(SQL Server) Demonstrate Binary Data Encoding Methods

(Visual Basic 6.0) Demonstrate Binary Data Encoding Methods

(VBScript) Demonstrate Binary Data Encoding Methods

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.

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.