XmlCertVault ActiveX Reference Documentation

XmlCertVault

Current Version: 10.1.2

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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing 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)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

LastErrorHtml As String (read-only)

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText As String (read-only)

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml As String (read-only)

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess As Long

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

LastStringResult

LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

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 "10.1.0"

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.