BinData C 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.

Create/Dispose

HCkBinData instance = CkBinData_Create();
// ...
CkBinData_Dispose(instance);
HCkBinData CkBinData_Create(void);

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.

void CkBinData_Dispose(HCkBinData handle);

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
BOOL CkBinData_getLastMethodSuccess(HCkBinData cHandle);
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.

top
NumBytes
int CkBinData_getNumBytes(HCkBinData cHandle);
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top
Utf8
BOOL CkBinData_getUtf8(HCkBinData cHandle);
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.

top

Methods

AppendBd
BOOL CkBinData_AppendBd(HCkBinData cHandle, HCkBinData binData);
Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns TRUE for success, FALSE for failure.

top
AppendBinary
BOOL CkBinData_AppendBinary(HCkBinData cHandle, HCkByteData data);
Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns TRUE for success, FALSE for failure.

top
AppendBom
BOOL CkBinData_AppendBom(HCkBinData cHandle, const char *charset);
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.

More Information and Examples
top
AppendEncoded
BOOL CkBinData_AppendEncoded(HCkBinData cHandle, const char *encData, const char *encoding);
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.

top
AppendEncodedSb
BOOL CkBinData_AppendEncodedSb(HCkBinData cHandle, HCkStringBuilder sb, const char *encoding);
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.

top
AppendSb
BOOL CkBinData_AppendSb(HCkBinData cHandle, HCkStringBuilder sb, const char *charset);
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
AppendString
BOOL CkBinData_AppendString(HCkBinData cHandle, const char *str, const char *charset);
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.

More Information and Examples
top
Clear
BOOL CkBinData_Clear(HCkBinData cHandle);
Introduced in version 9.5.0.51

Clears the contents.

Returns TRUE for success, FALSE for failure.

top
ContentsEqual
BOOL CkBinData_ContentsEqual(HCkBinData cHandle, HCkBinData binData);
Introduced in version 9.5.0.62

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

top
GetBinary
BOOL CkBinData_GetBinary(HCkBinData cHandle, HCkByteData outBytes);
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns TRUE for success, FALSE for failure.

top
GetBinaryChunk
BOOL CkBinData_GetBinaryChunk(HCkBinData cHandle, int offset, int numBytes, HCkByteData outBytes);
Introduced in version 9.5.0.51

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

Returns TRUE for success, FALSE for failure.

top
GetEncoded
BOOL CkBinData_GetEncoded(HCkBinData cHandle, const char *encoding, HCkString outStr);
const char *CkBinData_getEncoded(HCkBinData cHandle, const char *encoding);
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 TRUE for success, FALSE for failure.

top
GetEncodedChunk
BOOL CkBinData_GetEncodedChunk(HCkBinData cHandle, int offset, int numBytes, const char *encoding, HCkString outStr);
const char *CkBinData_getEncodedChunk(HCkBinData cHandle, int offset, int numBytes, const char *encoding);
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 TRUE for success, FALSE for failure.

More Information and Examples
top
GetEncodedSb
BOOL CkBinData_GetEncodedSb(HCkBinData cHandle, const char *encoding, HCkStringBuilder sb);
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.

More Information and Examples
top
GetString
BOOL CkBinData_GetString(HCkBinData cHandle, const char *charset, HCkString outStr);
const char *CkBinData_getString(HCkBinData cHandle, const char *charset);
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 TRUE for success, FALSE for failure.

More Information and Examples
top
LoadBinary
BOOL CkBinData_LoadBinary(HCkBinData cHandle, HCkByteData data);
Introduced in version 9.5.0.51

Loads binary data and replaces the current contents, if any.

Returns TRUE for success, FALSE for failure.

top
LoadEncoded
BOOL CkBinData_LoadEncoded(HCkBinData cHandle, const char *encData, const char *encoding);
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.

top
LoadFile
BOOL CkBinData_LoadFile(HCkBinData cHandle, const char *path);
Introduced in version 9.5.0.51

Loads data from a file.

Returns TRUE for success, FALSE for failure.

top
RemoveChunk
BOOL CkBinData_RemoveChunk(HCkBinData cHandle, int offset, int numBytes);
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
BOOL CkBinData_SecureClear(HCkBinData cHandle);
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.

top
WriteFile
BOOL CkBinData_WriteFile(HCkBinData cHandle, const char *path);
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns TRUE for success, FALSE for failure.

top