XmlCertVault DataFlex Reference Documentation

XmlCertVault

Current Version: 9.5.0.73

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

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoXmlCertVault
Get Create(RefClass(cComChilkatXmlCertVault)) to hoXmlCertVault

Properties

DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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.

top
LastBinaryResult
Function ComLastBinaryResult Returns Variant
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. 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
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
Introduced in version 9.5.0.52

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
LastStringResult
Function ComLastStringResult Returns String
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. 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
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

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

top
MasterPassword
Function ComMasterPassword Returns String
Procedure Set ComMasterPassword String value
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
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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

top
Version
Function ComVersion Returns String

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

top

Methods

AddCert
Function ComAddCert cComChilkatCert cert Returns Boolean
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns True for success, False for failure.

top
AddCertBinary
Function ComAddCertBinary Variant certBytes Returns Boolean
Introduced in version 9.5.0.40

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

Returns True for success, False for failure.

top
AddCertChain
Function ComAddCertChain cComChilkatCertChain certChain Returns Boolean
Introduced in version 9.5.0.40

Adds a chain of certificates to the XML vault.

Returns True for success, False for failure.

top
AddCertEncoded
Function ComAddCertEncoded String encodedBytes String encoding Returns Boolean
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 True for success, False for failure.

top
AddCertFile
Function ComAddCertFile String path Returns Boolean
Introduced in version 9.5.0.40

Adds a certificate to the XML vault.

Returns True for success, False for failure.

top
AddCertString
Function ComAddCertString String certData Returns Boolean
Introduced in version 9.5.0.40

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

Returns True for success, False for failure.

top
AddPemFile
Function ComAddPemFile String path String password Returns Boolean
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 True for success, False for failure.

top
AddPfx
Function ComAddPfx cComChilkatPfx pfx Returns Boolean
Introduced in version 9.5.0.40

Adds a PFX (PKCS12) to the XML vault.

Returns True for success, False for failure.

top
AddPfxBinary
Function ComAddPfxBinary Variant pfxBytes String password Returns Boolean
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 True for success, False for failure.

top
AddPfxEncoded
Function ComAddPfxEncoded String encodedBytes String encoding String password Returns Boolean

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 True for success, False for failure.

top
AddPfxFile
Function ComAddPfxFile String path String password Returns Boolean
Introduced in version 9.5.0.40

Adds a PFX file to the XML vault.

Returns True for success, False for failure.

top
GetXml
Function ComGetXml Returns String
Introduced in version 9.5.0.40

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

Returns null on failure

top
LoadXml
Function ComLoadXml String xml Returns Boolean
Introduced in version 9.5.0.40

Loads from an XML string.

Returns True for success, False for failure.

top
LoadXmlFile
Function ComLoadXmlFile String path Returns Boolean
Introduced in version 9.5.0.40

Loads from an XML file.

Returns True for success, False for failure.

top
SaveXml
Function ComSaveXml String path Returns Boolean
Introduced in version 9.5.0.40

Saves the contents to an XML file.

Returns True for success, False for failure.

top