TChilkatBinData Delphi ActiveX Reference Documentation

TChilkatBinData

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

Importing the Chilkat ActiveX into Delphi

Important: Whenever upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) will be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

var
obj: TChilkatBinData;
...
begin
obj := TChilkatBinData.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

property LastMethodSuccess: Integer

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

property NumBytes: Integer readonly

Introduced in version 9.5.0.51

The number of bytes contained within the object.

Methods

function AppendBd(binData: TChilkatBinData): Integer;

Introduced in version 9.5.0.62

Appends the contents of another BinData to this object.

Returns 1 for success, 0 for failure.

function AppendBinary(data: OleVariant): Integer;

Introduced in version 9.5.0.51

Appends binary data to the current contents, if any.

Returns 1 for success, 0 for failure.

function AppendBom(charset: WideString): Integer;

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 1 for success, 0 for failure.

StringBuilder to Bytes (in BinData)

function AppendEncoded(encData: WideString; encoding: WideString): Integer;

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 1 for success, 0 for failure.

Demonstrate Binary Data Encoding Methods

function AppendEncodedSb(sb: TChilkatStringBuilder; encoding: WideString): Integer;

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 1 for success, 0 for failure.

function AppendSb(sb: TChilkatStringBuilder; charset: WideString): Integer;

Introduced in version 9.5.0.62

Appends the contents of a StringBuilder to this object.

Returns 1 for success, 0 for failure.

StringBuilder to Bytes (in BinData)

function AppendString(str: WideString; charset: WideString): Integer;

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 1 for success, 0 for failure.

Appending Strings to BinData

function Clear(): Integer;

Introduced in version 9.5.0.51

Clears the contents.

Returns 1 for success, 0 for failure.

function ContentsEqual(binData: TChilkatBinData): Integer;

Introduced in version 9.5.0.62

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

function GetBinary(): OleVariant;

Introduced in version 9.5.0.51

Retrieves the binary data contained within the object.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

function GetBinaryChunk(offset: Integer; numBytes: Integer): OleVariant;

Introduced in version 9.5.0.51

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

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

function GetEncoded(encoding: WideString): WideString;

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 a zero-length WideString on failure

Demonstrate Binary Data Encoding Methods

Determine File Type from Binary Content of File

function GetEncodedChunk(offset: Integer; numBytes: Integer; encoding: WideString): WideString;

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 a zero-length WideString on failure

Demonstrate Binary Data Encoding Methods

function GetEncodedSb(encoding: WideString; sb: TChilkatStringBuilder): Integer;

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 1 for success, 0 for failure.

Demonstrate Binary Data Encoding Methods

function GetString(charset: WideString): WideString;

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 a zero-length WideString on failure

Chilkat Supported Character Encodings

function LoadBinary(data: OleVariant): Integer;

Introduced in version 9.5.0.51

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

Returns 1 for success, 0 for failure.

function LoadEncoded(encData: WideString; encoding: WideString): Integer;

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 1 for success, 0 for failure.

function LoadFile(path: WideString): Integer;

Introduced in version 9.5.0.51

Loads data from a file.

Returns 1 for success, 0 for failure.

function RemoveChunk(offset: Integer; numBytes: Integer): Integer;

Introduced in version 9.5.0.51

Removes a chunk of bytes from the binary data.

Demonstrate Binary Data Encoding Methods

function SecureClear(): Integer;

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 1 for success, 0 for failure.

function WriteFile(path: WideString): Integer;

Introduced in version 9.5.0.62

Writes the contents to a file.

Returns 1 for success, 0 for failure.