XmlCertVault ActiveX Reference Documentation

XmlCertVault

Current Version: 10.1.0

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

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.XmlCertVault" instead of "Chilkat.XmlCertVault"
For a specific major version, use "Chilkat.XmlCertVault.<major_version>", such as "Chilkat.XmlCertVault.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.XmlCertVault")

(AutoIt)
$obj = ObjCreate("Chilkat.XmlCertVault")

(Visual Basic 6.0)
Dim obj As New ChilkatXmlCertVault

(VBScript)
set obj = CreateObject("Chilkat.XmlCertVault")

(Delphi)
obj := TChilkatXmlCertVault.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.XmlCertVault')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.XmlCertVault")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.XmlCertVault', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.XmlCertVault");

Properties

DebugLogFilePath

DebugLogFilePath As String

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:

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

More Information and Examples

(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.

LastBinaryResult

LastBinaryResult As Variant (read-only)

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).

LastErrorHtml

LastErrorHtml As String (read-only)

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.

LastErrorText

LastErrorText As String (read-only)

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml As String (read-only)

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.

LastMethodSuccess

LastMethodSuccess As Long

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.

LastStringResult

LastStringResult As String (read-only)

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).

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

LastStringResultLen As Long (read-only)

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

MasterPassword

MasterPassword As String

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.

VerboseLogging

VerboseLogging As Long

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.

Version

Version As String (read-only)

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

More Information and Examples

(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.

Methods

AddCert

AddCert(cert As ChilkatCert) As Long

Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

AddCertBinary

AddCertBinary(certBytes As Variant) As Long

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.

AddCertChain

AddCertChain(certChain As ChilkatCertChain) As Long

Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns 1 for success, 0 for failure.

AddCertEncoded

AddCertEncoded(encodedBytes As String, encoding As String) As Long

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.

AddCertFile

AddCertFile(path As String) As Long

Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns 1 for success, 0 for failure.

More Information and Examples

(AutoIt) PKCS11 Certificate Chain (Classic ASP) PKCS11 Certificate Chain (PowerBuilder) PKCS11 Certificate Chain (SQL Server) PKCS11 Certificate Chain (VBScript) PKCS11 Certificate Chain (Visual Basic 6.0) PKCS11 Certificate Chain (Visual FoxPro) PKCS11 Certificate Chain (AutoIt) Sign PDF and Provide Certificates in Chain to Root (Classic ASP) Sign PDF and Provide Certificates in Chain to Root (PowerBuilder) Sign PDF and Provide Certificates in Chain to Root (SQL Server) Sign PDF and Provide Certificates in Chain to Root (VBScript) Sign PDF and Provide Certificates in Chain to Root (Visual Basic 6.0) Sign PDF and Provide Certificates in Chain to Root (Visual FoxPro) Sign PDF and Provide Certificates in Chain to Root

AddCertString

AddCertString(certData As String) As Long

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.

More Information and Examples

(AutoIt) Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial (Classic ASP) Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial (PowerBuilder) Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial (SQL Server) Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial (VBScript) Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial (Visual Basic 6.0) Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial (Visual FoxPro) Verify XML Signature having KeyInfo / X509Data / X509IssuerSerial

AddPemFile

AddPemFile(path As String, password As String) As Long

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.

AddPfx

AddPfx(pfx As ChilkatPfx) As Long

Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns 1 for success, 0 for failure.

AddPfxBinary

AddPfxBinary(pfxBytes As Variant, password As String) As Long

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.

AddPfxEncoded

AddPfxEncoded(encodedBytes As String, encoding As String, password As String) As Long

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.

AddPfxFile

AddPfxFile(path As String, password As String) As Long

Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns 1 for success, 0 for failure.

GetXml

GetXml() As String

Introduced in version 9.5.0.40

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

Returns Nothing on failure

LoadXml

LoadXml(xml As String) As Long

Introduced in version 9.5.0.40

Loads from an XML string.

Returns 1 for success, 0 for failure.

LoadXmlFile

LoadXmlFile(path As String) As Long

Introduced in version 9.5.0.40

Loads from an XML file.

Returns 1 for success, 0 for failure.

SaveXml

SaveXml(path As String) As Long

Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns 1 for success, 0 for failure.