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

obj.i = CkBinData::ckCreate()

; Make sure to dispose of the object when finished like this:
CkBinData::ckDispose(obj);

Properties

LastMethodSuccess
Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

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
Declare.i ckNumBytes(obj.i) ; (read-only)
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top

Methods

AppendBd
Declare.i ckAppendBd(obj.i, binData.i)
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns 1 for success, 0 for failure.

top
AppendBom
Declare.i ckAppendBom(obj.i, charset.s)
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.

More Information and Examples
top
AppendEncoded
Declare.i ckAppendEncoded(obj.i, encData.s, encoding.s)
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
Declare.i ckAppendEncodedSb(obj.i, sb.i, encoding.s)
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
Declare.i ckAppendSb(obj.i, sb.i, charset.s)
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns 1 for success, 0 for failure.

More Information and Examples
top
AppendString
Declare.i ckAppendString(obj.i, str.s, charset.s)
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.

More Information and Examples
top
Clear
Declare.i ckClear(obj.i)
Introduced in version 9.5.0.51

Clears the contents.

Returns 1 for success, 0 for failure.

top
ContentsEqual
Declare.i ckContentsEqual(obj.i, binData.i)
Introduced in version 9.5.0.62

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

top
GetEncoded
Declare.s ckGetEncoded(obj.i, encoding.s)
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 an empty string on failure. Use the LastMethodSuccess property to check for success.

top
GetEncodedChunk
Declare.s ckGetEncodedChunk(obj.i, offset.l, numBytes.l, encoding.s)
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 an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples
top
GetEncodedSb
Declare.i ckGetEncodedSb(obj.i, encoding.s, sb.i)
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.

More Information and Examples
top
GetString
Declare.s ckGetString(obj.i, charset.s)
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 an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples
top
LoadEncoded
Declare.i ckLoadEncoded(obj.i, encData.s, encoding.s)
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
Declare.i ckLoadFile(obj.i, path.s)
Introduced in version 9.5.0.51

Loads data from a file.

Returns 1 for success, 0 for failure.

top
RemoveChunk
Declare.i ckRemoveChunk(obj.i, offset.l, numBytes.l)
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
Declare.i ckSecureClear(obj.i)
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
Declare.i ckWriteFile(obj.i, path.s)
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns 1 for success, 0 for failure.

top