BinData Unicode C Reference Documentation

BinData

Current Version: 11.0.0

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

Create/Dispose

HCkBinDataW instance = CkBinDataW_Create();
// ...
CkBinDataW_Dispose(instance);
HCkBinDataW CkBinDataW_Create(void);

Creates an instance of the HCkBinDataW object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkBinDataW_Dispose(HCkBinDataW handle);

Objects created by calling CkBinDataW_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 CkBinDataW_Dispose.

Properties

DebugLogFilePath
void CkBinDataW_getDebugLogFilePath(HCkBinDataW cHandle, HCkString retval);
void CkBinDataW_putDebugLogFilePath(HCkBinDataW cHandle, const wchar_t *newVal);
const wchar_t *CkBinDataW_debugLogFilePath(HCkBinDataW cHandle);

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

  • A timeout property set to 0, indicating an infinite timeout.
  • A hang occurring within an event callback in the application code.
  • An internal bug in the Chilkat code causing the hang.

More Information and Examples
top
LastErrorHtml
void CkBinDataW_getLastErrorHtml(HCkBinDataW cHandle, HCkString retval);
const wchar_t *CkBinDataW_lastErrorHtml(HCkBinDataW cHandle);

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorText
void CkBinDataW_getLastErrorText(HCkBinDataW cHandle, HCkString retval);
const wchar_t *CkBinDataW_lastErrorText(HCkBinDataW cHandle);

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastErrorXml
void CkBinDataW_getLastErrorXml(HCkBinDataW cHandle, HCkString retval);
const wchar_t *CkBinDataW_lastErrorXml(HCkBinDataW cHandle);

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

top
LastMethodSuccess
BOOL CkBinDataW_getLastMethodSuccess(HCkBinDataW cHandle);
void CkBinDataW_putLastMethodSuccess(HCkBinDataW cHandle, BOOL newVal);

Indicates the success or failure of the most recent method call: TRUE means success, FALSE means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

top
NumBytes
int CkBinDataW_getNumBytes(HCkBinDataW cHandle);
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top
VerboseLogging
BOOL CkBinDataW_getVerboseLogging(HCkBinDataW cHandle);
void CkBinDataW_putVerboseLogging(HCkBinDataW cHandle, BOOL newVal);

If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
void CkBinDataW_getVersion(HCkBinDataW cHandle, HCkString retval);
const wchar_t *CkBinDataW_version(HCkBinDataW cHandle);

Version of the component/library, such as "10.1.0"

More Information and Examples
top

Methods

AppendBd
BOOL CkBinDataW_AppendBd(HCkBinDataW cHandle, HCkBinDataW 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 Deprecated
BOOL CkBinDataW_AppendBinary(HCkBinDataW 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 CkBinDataW_AppendBom(HCkBinDataW cHandle, const wchar_t *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.

top
AppendByte
BOOL CkBinDataW_AppendByte(HCkBinDataW cHandle, int byteValue);
Introduced in version 9.5.0.77

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

Returns TRUE for success, FALSE for failure.

top
AppendCountedString
BOOL CkBinDataW_AppendCountedString(HCkBinDataW cHandle, int numCountBytes, BOOL bigEndian, const wchar_t *str, const wchar_t *charset);
Introduced in version 9.5.0.91

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.

top
AppendData Deprecated
BOOL CkBinDataW_AppendData(HCkBinDataW cHandle, const void *data, int numBytes);
Introduced in version 11.0.0

Appends binary data to the current contents.

Returns TRUE for success, FALSE for failure.

top
AppendEncoded
BOOL CkBinDataW_AppendEncoded(HCkBinDataW cHandle, const wchar_t *encData, const wchar_t *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 CkBinDataW_AppendEncodedSb(HCkBinDataW cHandle, HCkStringBuilderW sb, const wchar_t *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
AppendInt2
BOOL CkBinDataW_AppendInt2(HCkBinDataW cHandle, int value, BOOL littleEndian);
Introduced in version 9.5.0.77

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.

More Information and Examples
top
AppendInt4
BOOL CkBinDataW_AppendInt4(HCkBinDataW cHandle, int value, BOOL littleEndian);
Introduced in version 9.5.0.77

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.

More Information and Examples
top
AppendPadded
BOOL CkBinDataW_AppendPadded(HCkBinDataW cHandle, const wchar_t *str, const wchar_t *charset, BOOL padWithSpace, int fieldLen);
Introduced in version 9.5.0.80

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.

top
AppendSb
BOOL CkBinDataW_AppendSb(HCkBinDataW cHandle, HCkStringBuilderW sb, const wchar_t *charset);
Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns TRUE for success, FALSE for failure.

top
AppendString
BOOL CkBinDataW_AppendString(HCkBinDataW cHandle, const wchar_t *str, const wchar_t *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
ByteSwap
void CkBinDataW_ByteSwap(HCkBinDataW cHandle, int size);
Introduced in version 11.0.0

Does either 16-bit or 32-bit byte swapping of the entire contents. If size equals 16, then swaps in 2 bytes (e.g., 0x1234 → 0x3412). If size equals 32, then swaps 4 bytes (e.g., 0x12345678 → 0x78563412)

Returns TRUE for success, FALSE for failure.

top
CharsetConvert
BOOL CkBinDataW_CharsetConvert(HCkBinDataW cHandle, const wchar_t *fromCharset, const wchar_t *toCharset, BOOL allOrNone);
Introduced in version 11.0.0

This method converts the character encoding of an object's contents from one format to another, such as from Windows-1252 to UTF-8. The allOrNone parameter determines error handling for unrepresentable bytes. If allOrNone is TRUE, the object's contents remain unchanged when errors occur. If FALSE, error bytes are discarded. The method returns TRUE if successful and FALSE if errors occur.

Returns TRUE for success, FALSE for failure.

top
Clear
BOOL CkBinDataW_Clear(HCkBinDataW cHandle);
Introduced in version 9.5.0.51

Clears the contents.

Returns TRUE for success, FALSE for failure.

top
ContentsEqual
BOOL CkBinDataW_ContentsEqual(HCkBinDataW cHandle, HCkBinDataW binData);
Introduced in version 9.5.0.62

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

top
FindString
int CkBinDataW_FindString(HCkBinDataW cHandle, const wchar_t *str, int startIdx, const wchar_t *charset);
Introduced in version 9.5.0.85

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.

top
GetBinary Deprecated
BOOL CkBinDataW_GetBinary(HCkBinDataW cHandle, const unsigned char * 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 Deprecated
BOOL CkBinDataW_GetBinaryChunk(HCkBinDataW cHandle, int offset, int numBytes, const unsigned char * 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
GetByte
int CkBinDataW_GetByte(HCkBinDataW cHandle, int index);
Introduced in version 9.5.0.92

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.

top
GetData Deprecated
const unsigned char * CkBinDataW_GetData(HCkBinDataW cHandle);
Introduced in version 11.0.0

Retrieves the binary data contained within the object.

Returns NULL on failure

top
GetDataChunk Deprecated
const unsigned char * CkBinDataW_GetDataChunk(HCkBinDataW cHandle, int offset, int numBytes);
Introduced in version 11.0.0

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

Returns NULL on failure

top
GetEncoded
BOOL CkBinDataW_GetEncoded(HCkBinDataW cHandle, const wchar_t *encoding, const wchar_t *outStr);
const wchar_t *CkBinDataW_getEncoded(HCkBinDataW cHandle, const wchar_t *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 CkBinDataW_GetEncodedChunk(HCkBinDataW cHandle, int offset, int numBytes, const wchar_t *encoding, const wchar_t *outStr);
const wchar_t *CkBinDataW_getEncodedChunk(HCkBinDataW cHandle, int offset, int numBytes, const wchar_t *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 CkBinDataW_GetEncodedSb(HCkBinDataW cHandle, const wchar_t *encoding, HCkStringBuilderW 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.

top
GetHash
BOOL CkBinDataW_GetHash(HCkBinDataW cHandle, const wchar_t *algorithm, const wchar_t *encoding, const wchar_t *outStr);
const wchar_t *CkBinDataW_getHash(HCkBinDataW cHandle, const wchar_t *algorithm, const wchar_t *encoding);
Introduced in version 9.5.0.91

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.

top
GetInt2
int CkBinDataW_GetInt2(HCkBinDataW cHandle, int index, BOOL littleEndian);
Introduced in version 9.5.0.88

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

top
GetInt4
int CkBinDataW_GetInt4(HCkBinDataW cHandle, int index, BOOL littleEndian);
Introduced in version 9.5.0.88

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

top
GetString
BOOL CkBinDataW_GetString(HCkBinDataW cHandle, const wchar_t *charset, const wchar_t *outStr);
const wchar_t *CkBinDataW_getString(HCkBinDataW cHandle, const wchar_t *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
GetTextChunk
BOOL CkBinDataW_GetTextChunk(HCkBinDataW cHandle, int startIdx, int numBytes, const wchar_t *charset, const wchar_t *outStr);
const wchar_t *CkBinDataW_getTextChunk(HCkBinDataW cHandle, int startIdx, int numBytes, const wchar_t *charset);
Introduced in version 9.5.0.85

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.

top
GetUInt2
unsigned long CkBinDataW_GetUInt2(HCkBinDataW cHandle, int index, BOOL littleEndian);
Introduced in version 9.5.0.88

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

top
GetUInt4
unsigned long CkBinDataW_GetUInt4(HCkBinDataW cHandle, int index, BOOL littleEndian);
Introduced in version 9.5.0.88

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

top
IsValidUtf8
BOOL CkBinDataW_IsValidUtf8(HCkBinDataW cHandle);
Introduced in version 10.1.0

Returns TRUE 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 FALSE.

Returns TRUE for success, FALSE for failure.

top
LoadBinary Deprecated
BOOL CkBinDataW_LoadBinary(HCkBinDataW 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 CkBinDataW_LoadEncoded(HCkBinDataW cHandle, const wchar_t *encData, const wchar_t *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 CkBinDataW_LoadFile(HCkBinDataW cHandle, const wchar_t *path);
Introduced in version 9.5.0.51

Loads data from a file.

Returns TRUE for success, FALSE for failure.

top
RemoveByteVal
void CkBinDataW_RemoveByteVal(HCkBinDataW cHandle, int value);
Introduced in version 9.5.0.90

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

top
RemoveChunk
BOOL CkBinDataW_RemoveChunk(HCkBinDataW 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 CkBinDataW_SecureClear(HCkBinDataW 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
WriteAppendFile
BOOL CkBinDataW_WriteAppendFile(HCkBinDataW cHandle, const wchar_t *path);
Introduced in version 9.5.0.91

Appends the contents of this object to a file.

Returns TRUE for success, FALSE for failure.

top
WriteFile
BOOL CkBinDataW_WriteFile(HCkBinDataW cHandle, const wchar_t *path);
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns TRUE for success, FALSE for failure.

top