BinData

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

The number of bytes contained within the object.

Appends the contents of another BinData to this object.

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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

Returns .T. for success, .F. for failure.

Appends a byte count followed by the string in the desired character encoding, such as "utf-8". The numCountBytes is the size in bytes of the integer to represent the byte count. If 0, then a minimal number of bytes is used. If bigEndian is .T., the byte count is appended in big endian byte ordering, otherwise little-ending byte ordering. The str is the string to be appended. The charset is the character encoding, such as "utf-8", "utf-16", "windows-1252", etc.

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

Appends a 16-bit integer (2 bytes). If littleEndian is .T., then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns .T. for success, .F. for failure.

Appends a 32-bit integer (4 bytes). If littleEndian is .T., then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.

Returns .T. for success, .F. for failure.

Appends a string to this object, padded to the fieldLen with NULL or SPACE chars. If padWithSpace is .T., then SPACE chars are used and the string is not null-terminated. If fieldLen is .F., 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 .F. to indicate failure and nothing is appended.

Returns .T. for success, .F. for failure.

Appends the contents of a StringBuilder to this object.

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

Clears the contents.

Returns .T. for success, .F. for failure.

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

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.

Returns the value of the byte at the given index. The returned value is an integer from 0 to 255.

Returns .T. for success, .F. for failure.

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 .F. on failure

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 .F. on failure

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 .T. for success, .F. for failure.

Returns the hash of the contents of this object. The algorithm is the hash algorithm, and can be "sha1", "sha256", "sha384", "sha512", "sha3-224", "sha3-256", "sha3-384", "sha3-512", "md2", "md5", "ripemd128", "ripemd160","ripemd256", or "ripemd320". The encoding can be "base64", "modBase64", "base64Url", "base32", "base58", "qp" (for quoted-printable), "url" (for url-encoding), "hex", "hexLower", or any of the encodings found at Chilkat Binary Encodings List.

Returns .F. on failure

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

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

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 .F. on failure

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

Returns .F. on failure

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

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

Returns .T. if this object contains valid utf-8 byte sequences. Any invalid byte sequence that is not valid utf-8 will cause this function to return .F..

Returns .T. for success, .F. for failure.

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 .T. for success, .F. for failure.

Loads data from a file.

Returns .T. for success, .F. for failure.

Removes bytes having a specified value (0-255). For example, to remove all null bytes, pass 0 in value.

Removes a chunk of bytes from the binary data.

Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.

Returns .T. for success, .F. for failure.

Appends the contents of this object to a file.

Returns .T. for success, .F. for failure.

Writes the contents to a file.

Returns .T. for success, .F. for failure.