CkByteData C Reference Documentation
Current Version: 126.96.36.199
Represents a chunk of byte data and provides methods for accessing it, adding to it, or saving and loading from files.
HCkByteData instance = CkByteData_Create(); // ... CkByteData_Dispose(instance);
Creates an instance of the HCkByteData 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 CkByteData_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 CkByteData_Dispose.
void CkByteData_putSecureClear(HCkByteData cHandle, BOOL newVal);
If set to TRUE, then memory is always first overwritten with zero bytes prior to deallocation. The default value of this property is FALSE.top
Appends byte data to the data already contained in the object.top
Appends bytes to the data already contained in the object.top
Appends a single byte.top
Appends a single char N times. The equivalent of calling appendChar N times.top
Appends binary data from an encoded string. The encoding can be specified as "hex", "base64", "url", "quoted-printable", "modBase64", "base58", or "base32". The input string is decoded from the specified encoding and the binary data is appended to the calling object's content.top
Opens a file for binary read, appends the file contents, and closes the file.top
Appends a 32-bit signed integer (4 bytes) to the data already contained in the object. littleEndian determines whether the big endian or little endian byte ordering is used.top
Appends numBytes random bytes to the data already contained within the object.top
Appends a range of bytes from byteData to the data contained withing the caller. The first byte is at index 0.top
Appends a 16-bit signed integer (2 bytes) to the data already contained in the object. littleEndian determines whether the big endian or little endian byte ordering is used.top
Appends a null-terminated string to the data, without including the terminating null.top
Returns TRUE if the caller's data begins with the exact bytes contained within byteDataObj.top
Returns TRUE if the caller's data begins with specified bytes.top
Sets the CkByteData's data pointer and size to memory outside the object. This is useful in cases where a CkByteData object is needed, but copying data into the CkByteData is not desired.
Note: The borrowData method can only be used for data that is being passed into a Chilkat method call. It is not for use as a buffer for Chilkat to deposit data. This is not the intent of the method.
4321 byte swaps the data contained within the object.top
Clears the CkByteData object of all data.top
Encodes binary data according to the encoding requested. The encoding can be specified as "hex", "base64", "url", "quoted-printable", "modBase64", "base58", "base32", "qp-
This method can be called to help optimize internal memory re-allocation. If, for example, many calls will be made to append data, and the total size is approximately known, then this method can be called to pre-allocate the internal buffer to the expected total size.
Returns TRUE for success, FALSE for failure.top
Returns TRUE if compareBytes contains exactly the same content as the caller. Otherwise returns FALSE.top
Returns TRUE if the bytes pointed to by pCompareBytes contains exactly the same content as the caller. Otherwise returns FALSE.top
Locates the first occurrence of the bytes contained in byteDataObj and returns the index of where these bytes occur in the caller's data. Returns -1 if not found.top
Locates the first occurrence of the specified bytes and returns the index of where these bytes occur in the caller's data. Returns -1 if not found.top
Returns the Nth byte of the binary data. The 1st byte is at index 0.top
Returns the Nth byte of the binary content as a "char". The 1st byte is at index 0.top
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.top
Same as getData, except it gets a pointer to the data at a byte offset. (0 = the start of buffer)top
The utf-16 version of getEncoded.top
Returns the 4-byte integer located at a specific byte index.top
Copies a range of bytes to a separate internal memory buffer and returns the pointer to the bytes. The returned pointer is only valid while the object exists. Also, any subsequent calls to getRange, getRangeStr, or to_s will invalidate the buffer.top
Returns the 2-byte integer located at a specific byte index.top
Returns the number of bytes in the data buffer.top
Returns the 4-byte unsigned integer located at a specific byte index.top
Returns the 2-byte unsigned integer located at a specific byte index.top
Returns TRUE if all the bytes are in the range 0x00 to 0x7F.top
Equivalent to clear() followed by appendFile().top
Pads the data to a multiple of the blockSize using a cryptographic padding scheme specified by paddingScheme. The possible integer values for paddingScheme are the same as those listed for the PaddingScheme property of the CkCrypt2 class.top
Removes (discards) a range from the data.top
Removes the data from the CkByteData object. The caller will receivea pointer to the memory buffer, and is responsible for deleting it.
unsigned char *data = byteData.removeData();
... do something with the data....
delete  data;
Replaces all occurrences of existingByteValue with replacementByteValue.top
Saves the byte data to a file. If the file already exists, it will be overwritten.top
Discards N bytes from the end of the data.top
Unpads the data from a multiple of the blockSize to the original data size using a cryptographic padding scheme specified by paddingScheme. The possible integer values for paddingScheme are the same as those listed for the PaddingScheme property of the CkCrypt2 class.top