BinData C Reference Documentation
BinData
Current Version: 10.0.0
Container for binary data. Provides methods for getting, setting, appending, etc. in binary and string encoded formats.
Create/Dispose
HCkBinData instance = CkBinData_Create(); // ... CkBinData_Dispose(instance);
Creates an instance of the HCkBinData object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkBinData_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkBinData_Dispose.
Properties
LastMethodSuccess
void CkBinData_putLastMethodSuccess(HCkBinData cHandle, BOOL newVal);
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.
topNumBytes
The number of bytes contained within the object.
topUtf8
void CkBinData_putUtf8(HCkBinData cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topMethods
AppendBd
Appends the contents of another BinData to this object.
Returns TRUE for success, FALSE for failure.
topAppendBinary
Appends binary data to the current contents, if any.
Returns TRUE for success, FALSE for failure.
topAppendBinary2
Appends binary data to the current contents, if any.
Returns TRUE for success, FALSE for failure.
topAppendBom
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.
AppendByte
Appends a single byte. The byteValue should be a value from 0 to 255.
Returns TRUE for success, FALSE for failure.
topAppendCountedString
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 TRUE, 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 TRUE for success, FALSE for failure.
topAppendEncoded
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.
AppendEncodedSb
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.
AppendInt2
Appends a 16-bit integer (2 bytes). If littleEndian is TRUE, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.
Returns TRUE for success, FALSE for failure.
AppendInt4
Appends a 32-bit integer (4 bytes). If littleEndian is TRUE, then the integer bytes are appended in little-endian byte order, otherwise big-endian byte order is used.
Returns TRUE for success, FALSE for failure.
AppendPadded
Appends a string to this object, padded to the fieldLen with NULL or SPACE chars. If padWithSpace is TRUE, then SPACE chars are used and the string is not null-terminated. If fieldLen is FALSE, 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 FALSE to indicate failure and nothing is appended.
Returns TRUE for success, FALSE for failure.
AppendSb
Appends the contents of a StringBuilder to this object.
Returns TRUE for success, FALSE for failure.
AppendString
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.
Clear
ContentsEqual
Return TRUE if the contents of this object equals the contents of binData.
topFindString
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.
topGetBinary
Retrieves the binary data contained within the object.
Returns TRUE for success, FALSE for failure.
topGetBinaryChunk
Retrieves a chunk of the binary data contained within the object.
Returns TRUE for success, FALSE for failure.
topGetByte
Returns the value of the byte at the given index. The returned value is an integer from 0 to 255.
Returns TRUE for success, FALSE for failure.
topGetBytesPtr
Returns a pointer to the internal buffer. Be careful with this method because if additional data is appended, the data within the object may be relocated and the pointer may cease to be valid.
topGetEncoded
const char *CkBinData_getEncoded(HCkBinData cHandle, const char *encoding);
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 TRUE for success, FALSE for failure.
GetEncodedChunk
const char *CkBinData_getEncodedChunk(HCkBinData cHandle, int offset, int numBytes, const char *encoding);
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 TRUE for success, FALSE for failure.
GetEncodedSb
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.
GetHash
const char *CkBinData_getHash(HCkBinData cHandle, const char *algorithm, const char *encoding);
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 TRUE for success, FALSE for failure.
topGetInt2
Returns the value of the 16-bit signed integer stored in big-endian or little-endian byte ordering at the given index.
topGetInt4
Returns the value of the 32-bit signed integer stored in big-endian or little-endian byte ordering at the given index.
topGetString
const char *CkBinData_getString(HCkBinData cHandle, const char *charset);
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 TRUE for success, FALSE for failure.
GetTextChunk
const char *CkBinData_getTextChunk(HCkBinData cHandle, int startIdx, int numBytes, const char *charset);
Returns numBytes bytes starting at startIdx. The bytes are interpreted according to charset (for example, "utf-8", "ansi", "utf-16", "windows-1252", etc.)
Returns TRUE for success, FALSE for failure.
topGetUInt2
Returns the value of the 16-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.
topGetUInt4
Returns the value of the 32-bit unsigned integer stored in big-endian or little-endian byte ordering at the given index.
topLoadBinary
Loads binary data and replaces the current contents, if any.
Returns TRUE for success, FALSE for failure.
topLoadBinary2
Loads binary data and replaces the current contents, if any.
Returns TRUE for success, FALSE for failure.
topLoadEncoded
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.
topLoadFile
RemoveByteVal
Removes bytes having a specified value (0-255). For example, to remove all null bytes, pass 0 in value.
topRemoveChunk
SecureClear
Securely clears the contents by writing 0 bytes to the memory prior to deallocating the internal memory.
Returns TRUE for success, FALSE for failure.
top