BinData Delphi DLL 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

var
myObject: HCkBinData;

begin
myObject := CkBinData_Create();

// ...

CkBinData_Dispose(myObject);
end;
function CkBinData_Create: HCkBinData; stdcall;

Creates an instance of the HCkBinData object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkBinData_Dispose(handle: HCkBinData); stdcall;

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.

Properties

LastMethodSuccess
function CkBinData_getLastMethodSuccess(objHandle: HCkBinData): wordbool; stdcall;
procedure CkBinData_putLastMethodSuccess(objHandle: HCkBinData; newPropVal: wordbool); stdcall;

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
function CkBinData_getNumBytes(objHandle: HCkBinData): Integer; stdcall;
Introduced in version 9.5.0.51

The number of bytes contained within the object.

top

Methods

AppendBd
function CkBinData_AppendBd(objHandle: HCkBinData;
    binData: HCkBinData): wordbool; stdcall;
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
function CkBinData_AppendBinary(objHandle: HCkBinData;
    data: HCkByteData): wordbool; stdcall;
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
function CkBinData_AppendBom(objHandle: HCkBinData;
    charset: PWideChar): wordbool; stdcall;
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
function CkBinData_AppendEncoded(objHandle: HCkBinData;
    encData: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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
function CkBinData_AppendEncodedSb(objHandle: HCkBinData;
    sb: HCkStringBuilder;
    encoding: PWideChar): wordbool; stdcall;
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
function CkBinData_AppendSb(objHandle: HCkBinData;
    sb: HCkStringBuilder;
    charset: PWideChar): wordbool; stdcall;
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
function CkBinData_AppendString(objHandle: HCkBinData;
    str: PWideChar;
    charset: PWideChar): wordbool; stdcall;
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
function CkBinData_Clear(objHandle: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.51

Clears the contents.

Returns True for success, False for failure.

top
ContentsEqual
function CkBinData_ContentsEqual(objHandle: HCkBinData;
    binData: HCkBinData): wordbool; stdcall;
Introduced in version 9.5.0.62

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

top
GetBinary
function CkBinData_GetBinary(objHandle: HCkBinData;
    outBytes: HCkByteData): wordbool; stdcall;
Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns True for success, False for failure.

top
GetBinaryChunk
function CkBinData_GetBinaryChunk(objHandle: HCkBinData;
    offset: Integer;
    numBytes: Integer;
    outBytes: HCkByteData): wordbool; stdcall;
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
function CkBinData_GetEncoded(objHandle: HCkBinData;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkBinData__getEncoded(objHandle: HCkBinData;
    encoding: PWideChar): PWideChar; stdcall;
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
function CkBinData_GetEncodedChunk(objHandle: HCkBinData;
    offset: Integer;
    numBytes: Integer;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkBinData__getEncodedChunk(objHandle: HCkBinData;
    offset: Integer;
    numBytes: Integer;
    encoding: PWideChar): PWideChar; stdcall;
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
function CkBinData_GetEncodedSb(objHandle: HCkBinData;
    encoding: PWideChar;
    sb: HCkStringBuilder): wordbool; stdcall;
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
function CkBinData_GetString(objHandle: HCkBinData;
    charset: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkBinData__getString(objHandle: HCkBinData;
    charset: PWideChar): PWideChar; stdcall;
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
function CkBinData_LoadBinary(objHandle: HCkBinData;
    data: HCkByteData): wordbool; stdcall;
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
function CkBinData_LoadEncoded(objHandle: HCkBinData;
    encData: PWideChar;
    encoding: PWideChar): wordbool; stdcall;
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
function CkBinData_LoadFile(objHandle: HCkBinData;
    path: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.51

Loads data from a file.

Returns True for success, False for failure.

top
RemoveChunk
function CkBinData_RemoveChunk(objHandle: HCkBinData;
    offset: Integer;
    numBytes: Integer): wordbool; stdcall;
Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

More Information and Examples
top
SecureClear
function CkBinData_SecureClear(objHandle: HCkBinData): wordbool; stdcall;
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
function CkBinData_WriteFile(objHandle: HCkBinData;
    path: PWideChar): wordbool; stdcall;
Introduced in version 9.5.0.62

Writes the contents to a file.

Returns True for success, False for failure.

top