CertChain ActiveX Reference Documentation

CertChain

Contains certificates in a chain of authentication to a trusted root.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatCertChain

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.CertChain")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.CertChain")

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

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.CertChain')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.CertChain")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.CertChain', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.CertChain");

Properties

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:

  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.

LastBinaryResult As Variant (read-only)

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

Concept of LastErrorText

LastErrorText Standard Information

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 As Long

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.

LastStringResult As String (read-only)

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

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

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

NumCerts As Long (read-only)

Introduced in version 9.5.0.40

The number of certificates in the chain. The end-user subscriber certificate is at index 0. This is the certificate most removed from the trusted root. Intermediate certificates are at indices 1 to NumCerts - 2. The trusted root (or self-signed certificate) is at index NumCerts - 1.

NumExpiredCerts As Long (read-only)

Introduced in version 9.5.0.40

Returns the number of certificates in the chain that have expired.

ReachesRoot As Long (read-only)

Introduced in version 9.5.0.44

1 if this certificate chain extends all the way to the root certificate. The root certificate is either a trusted CA root or a self-signed certificate. In both cases, the issuer of a root certificate is itself.

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 As String (read-only)

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

Methods

GetCert(ByVal index As Long) As ChilkatCert

Introduced in version 9.5.0.40

Returns the Nth certificate in the chain.

Returns Nothing on failure

IsRootTrusted(trustedRoots As ChilkatTrustedRoots) As Long

Introduced in version 9.5.0.40

Returns 1 if the root of the certificate chain is a certificate found in trustedRoots.

LoadX5C(jwk As ChilkatJsonObject) As Long

Introduced in version 9.5.0.66

Loads a certificate chain from the "x5c" parameter of a JWK (JSON Web Key).

Returns 1 for success, 0 for failure.

VerifyCertSignatures() As Long

Introduced in version 9.5.0.40

Verifies the certificate signatures to the root. Returns 1 if all certificate signatures are valid.