TChilkatXmlCertVault Delphi ActiveX Reference Documentation

TChilkatXmlCertVault

Current Version: 10.0.0

Contains a collection of certificates and PFX files saved in an XML format.

Importing the Chilkat ActiveX into Delphi

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


Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).


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. See also: ActiveX Registration Tutorial
  3. 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_TLB.pas and Chilkat_TLB.dcr. The Chilkat_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" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-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) should 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_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_TLB;

Object Creation

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

Properties

DebugLogFilePath
property DebugLogFilePath: WideString

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

More Information and Examples
top
LastBinaryResult
property LastBinaryResult: OleVariant readonly

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
property LastErrorHtml: WideString readonly

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
property LastErrorText: WideString readonly

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
property LastErrorXml: WideString readonly

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
property LastMethodSuccess: Integer

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.

top
LastStringResult
property LastStringResult: WideString readonly

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
property LastStringResultLen: Integer readonly

The length, in characters, of the string contained in the LastStringResult property.

top
MasterPassword
property MasterPassword: WideString
Introduced in version 9.5.0.40

The master password for the vault. Certificates are stored unencrypted, but private keys are stored 256-bit AES encrypted using the individual PFX passwords. The PFX passwords are stored 256-bit AES encrypted using the master password. The master password is required to acces any of the private keys stored within the XML vault.

top
VerboseLogging
property VerboseLogging: Integer

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

top
Version
property Version: WideString readonly

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

More Information and Examples
top

Methods

AddCert
function AddCert(cert: TChilkatCert): Integer;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

top
AddCertBinary
function AddCertBinary(certBytes: OleVariant): Integer;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault from any binary format, such as DER.

Returns 1 for success, 0 for failure.

top
AddCertChain
function AddCertChain(certChain: TChilkatCertChain): Integer;
Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns 1 for success, 0 for failure.

top
AddCertEncoded
function AddCertEncoded(encodedBytes: WideString; encoding: WideString): Integer;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault where certificate is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by encoding.

Returns 1 for success, 0 for failure.

top
AddCertFile
function AddCertFile(path: WideString): Integer;
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

top
AddCertString
function AddCertString(certData: WideString): Integer;
Introduced in version 9.5.0.40

Adds a certificate from any string representation format such as PEM.

Returns 1 for success, 0 for failure.

top
AddPemFile
function AddPemFile(path: WideString; password: WideString): Integer;
Introduced in version 9.5.0.40

Adds the contents of a PEM file to the XML vault. The PEM file may be encrypted, and it may contain one or more certificates and/or private keys. The password is optional and only required if the PEM file contains encrypted content that requires a password.

Returns 1 for success, 0 for failure.

top
AddPfx
function AddPfx(pfx: TChilkatPfx): Integer;
Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns 1 for success, 0 for failure.

top
AddPfxBinary
function AddPfxBinary(pfxBytes: OleVariant; password: WideString): Integer;
Introduced in version 9.5.0.40

Adds a PFX to the XML vault where PFX is passed directly from in-memory binary bytes.

Returns 1 for success, 0 for failure.

top
AddPfxEncoded
function AddPfxEncoded(encodedBytes: WideString; encoding: WideString; password: WideString): Integer;

Adds a PFX to the XML vault where PFX is passed directly from encoded bytes (such as Base64, Hex, etc.). The encoding is indicated by encoding.

Returns 1 for success, 0 for failure.

top
AddPfxFile
function AddPfxFile(path: WideString; password: WideString): Integer;
Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns 1 for success, 0 for failure.

top
GetXml
function GetXml(): WideString;
Introduced in version 9.5.0.40

Returns the contents of the cert vault as an XML string.

Returns a zero-length WideString on failure

top
LoadXml
function LoadXml(xml: WideString): Integer;
Introduced in version 9.5.0.40

Loads from an XML string.

Returns 1 for success, 0 for failure.

top
LoadXmlFile
function LoadXmlFile(path: WideString): Integer;
Introduced in version 9.5.0.40

Loads from an XML file.

Returns 1 for success, 0 for failure.

top
SaveXml
function SaveXml(path: WideString): Integer;
Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns 1 for success, 0 for failure.

top