BinData DataFlex Reference Documentation

BinData

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

Object Creation

Handle hoBinData
Get Create(RefClass(cComChilkatBinData)) to hoBinData

Properties

Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value

Introduced in version 9.5.0.52

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.

Function ComNumBytes Returns Integer

Introduced in version 9.5.0.51

The number of bytes contained within the object.

Methods

Function ComAppendBd cComChilkatBinData binData Returns Boolean

Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns True for success, False for failure.

Function ComAppendBinary Variant data Returns Boolean

Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns True for success, False for failure.

Function ComAppendBom String charset Returns 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.

StringBuilder to Bytes (in BinData)

Function ComAppendEncoded String encData String encoding Returns 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.

Demonstrate Binary Data Encoding Methods

Function ComAppendEncodedSb cComChilkatStringBuilder sb String encoding Returns 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.

Function ComAppendSb cComChilkatStringBuilder sb String charset Returns Boolean

Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns True for success, False for failure.

StringBuilder to Bytes (in BinData)

Function ComAppendString String str String charset Returns 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.

Appending Strings to BinData

Function ComClear Returns Boolean

Introduced in version 9.5.0.51

Clears the contents.

Returns True for success, False for failure.

Function ComContentsEqual cComChilkatBinData binData Returns Boolean

Introduced in version 9.5.0.62

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

Function ComGetBinary Returns Variant

Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns null on failure

Function ComGetBinaryChunk Integer offset Integer numBytes Returns Variant

Introduced in version 9.5.0.51

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

Returns null on failure

Function ComGetEncoded String encoding Returns 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

Demonstrate Binary Data Encoding Methods

Determine File Type from Binary Content of File

Function ComGetEncodedChunk Integer offset Integer numBytes String encoding Returns 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

Demonstrate Binary Data Encoding Methods

Function ComGetEncodedSb String encoding cComChilkatStringBuilder sb Returns 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.

Demonstrate Binary Data Encoding Methods

Function ComGetString String charset Returns 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

Chilkat Supported Character Encodings

Function ComLoadBinary Variant data Returns 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.

Function ComLoadEncoded String encData String encoding Returns 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.

Function ComLoadFile String path Returns Boolean

Introduced in version 9.5.0.51

Loads data from a file.

Returns True for success, False for failure.

Function ComRemoveChunk Integer offset Integer numBytes Returns Boolean

Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

Demonstrate Binary Data Encoding Methods

Function ComSecureClear Returns 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.

Function ComWriteFile String path Returns Boolean

Introduced in version 9.5.0.62

Writes the contents to a file.

Returns True for success, False for failure.