TrustedRoots ActiveX Reference Documentation

TrustedRoots

Used to set and manage the CA root certificates trusted by your application. This applies to PKCS7 (S/MIME) signature validation and SSL/TLS server certificates.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatTrustedRoots

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

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

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

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

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

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

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

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

The number of certificates contained within this object.

This is the number of certificates explicitly added by the methods AddCert, AddJavaKeyStore, and LoadCaCertsPem.

TrustSystemCaRoots As Long

Introduced in version 9.5.0.41

Indicates whether the operating system's CA root certificates are automatically trusted.

On a Windows operating system, this would be the registry-based CA certificate stores. On a Linux system, this could be /etc/ssl/certs/ca-certificates.crt, if it exists. The default value is 1. Set this property equal to 0 to prevent Chilkat from automatically trusting system-provided root CA certificates.

(Classic ASP) HTTP - Verify Server is a Trusted Root CA

(Visual FoxPro) HTTP - Verify Server is a Trusted Root CA

(PowerBuilder) HTTP - Verify Server is a Trusted Root CA

(SQL Server) HTTP - Verify Server is a Trusted Root CA

(Visual Basic 6.0) HTTP - Verify Server is a Trusted Root CA

(VBScript) HTTP - Verify Server is a Trusted Root CA

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

Activate() As Long

Introduced in version 9.5.0.38

Activates this collection of trusted roots as the set of CA and self-signed root certificates that are to be trusted Chilkat-wide for PKCS7 signature validation and SSL/TLS server certificate validation.

(Classic ASP) HTTP - Verify Server is a Trusted Root CA

(Visual FoxPro) HTTP - Verify Server is a Trusted Root CA

(PowerBuilder) HTTP - Verify Server is a Trusted Root CA

(SQL Server) HTTP - Verify Server is a Trusted Root CA

(Visual Basic 6.0) HTTP - Verify Server is a Trusted Root CA

(VBScript) HTTP - Verify Server is a Trusted Root CA

AddCert(cert As ChilkatCert) As Long

Introduced in version 9.5.0.41

Adds a certificate to the collection of trusted roots.

(Classic ASP) Use a Custom Set of Trusted Root Certificates

(Visual FoxPro) Use a Custom Set of Trusted Root Certificates

(PowerBuilder) Use a Custom Set of Trusted Root Certificates

(SQL Server) Use a Custom Set of Trusted Root Certificates

(Visual Basic 6.0) Use a Custom Set of Trusted Root Certificates

(VBScript) Use a Custom Set of Trusted Root Certificates

AddJavaKeyStore(keystore As ChilkatJavaKeyStore) As Long

Introduced in version 9.5.0.44

Adds the trusted certificates from a Java key store to the collection of trusted roots.

Returns 1 for success, 0 for failure.

(Classic ASP) Load Certs from Java KeyStore into Trusted CA Roots

(Visual FoxPro) Load Certs from Java KeyStore into Trusted CA Roots

(PowerBuilder) Load Certs from Java KeyStore into Trusted CA Roots

(SQL Server) Load Certs from Java KeyStore into Trusted CA Roots

(Visual Basic 6.0) Load Certs from Java KeyStore into Trusted CA Roots

(VBScript) Load Certs from Java KeyStore into Trusted CA Roots

AddJavaKeyStoreAsync(keystore As ChilkatJavaKeyStore) As ChilkatTask

Introduced in version 9.5.0.44

Creates an asynchronous task to call the AddJavaKeyStore method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

Deactivate() As Long

Introduced in version 9.5.0.40

Deactivates a previously set of activated trusted roots so that all roots / self-signed certificates are implicitly trusted.

Returns 1 for success, 0 for failure.

GetCert(ByVal index As Long) As ChilkatCert

Introduced in version 9.5.0.38

Returns the Nth cert contained within this object. The 1st certificate is at index 0.

Returns Nothing on failure

(Classic ASP) Load CA Cert Bundle into Trusted Roots

(Visual FoxPro) Load CA Cert Bundle into Trusted Roots

(PowerBuilder) Load CA Cert Bundle into Trusted Roots

(SQL Server) Load CA Cert Bundle into Trusted Roots

(Visual Basic 6.0) Load CA Cert Bundle into Trusted Roots

(VBScript) Load CA Cert Bundle into Trusted Roots

LoadCaCertsPem(path As String) As Long

Introduced in version 9.5.0.38

Loads a CA bundle in PEM format. This is a file containing CA root certificates that are to be trusted. An example of one such file is the CA certs from mozilla.org exported to a cacert.pem file by the mk-ca-bundle tool located here: http://curl.haxx.se/docs/caextract.html.

Note: This can also be called to load the /etc/ssl/certs/ca-certificates.crt file on Linux systems.

(Classic ASP) Load CA Cert Bundle into Trusted Roots

(Visual FoxPro) Load CA Cert Bundle into Trusted Roots

(PowerBuilder) Load CA Cert Bundle into Trusted Roots

(SQL Server) Load CA Cert Bundle into Trusted Roots

(Visual Basic 6.0) Load CA Cert Bundle into Trusted Roots

(VBScript) Load CA Cert Bundle into Trusted Roots

LoadCaCertsPemAsync(path As String) As ChilkatTask

Introduced in version 9.5.0.38

Creates an asynchronous task to call the LoadCaCertsPem method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns Nothing on failure

(Classic ASP) How to Run an Asynchronous Task

(Visual FoxPro) How to Run an Asynchronous Task

(PowerBuilder) How to Run an Asynchronous Task

(SQL Server) How to Run an Asynchronous Task

(Visual Basic 6.0) How to Run an Asynchronous Task

(VBScript) How to Run an Asynchronous Task

Asynchronous Methods in VB6 - Be Very Careful with Callbacks

Events

AbortCheck(abort As Long)

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myTrustedroots As ChilkatTrustedRoots

Private Sub myTrustedroots_AbortCheck(abort As Long)

	'Insert application code here.

End Sub

BinaryData(data As Variant)

Binary data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myTrustedroots As ChilkatTrustedRoots

Private Sub myTrustedroots_BinaryData(data As Variant)

	'Insert application code here.

End Sub

PercentDone(ByVal pctDone As Long, abort As Long)

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myTrustedroots As ChilkatTrustedRoots

Private Sub myTrustedroots_PercentDone(ByVal pctDone As Long, abort As Long)

	'Insert application code here.

End Sub

ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myTrustedroots As ChilkatTrustedRoots

Private Sub myTrustedroots_ProgressInfo(name As String, value As String)

	'Insert application code here.

End Sub

TextData(data As String)

Text data provided by certain methods.

VB6 Event callback implementation:

Important: Event callbacks from asynchronous method calls are generally not possible from the ActiveX. See VB6 Async Callbacks

Dim WithEvents myTrustedroots As ChilkatTrustedRoots

Private Sub myTrustedroots_TextData(data As String)

	'Insert application code here.

End Sub