TrustedRoots

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.

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.

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.

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.

Indicates the success or failure of the most recent method call: true means success, false 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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

The number of certificates explicitly contained in this object. The count includes certificates added by AddCert, AddJavaKeyStore, and LoadCaCertsPem.

Use indexes from 0 through NumCerts - 1 with CertAt.

Controls the special case in which an SSL/TLS server presents a certificate chain containing exactly one certificate and that certificate is self-signed. The default value is false.

This property applies to the TLS server-certificate case described above. It does not reject a self-signed CA certificate merely because that certificate appears as the trust anchor above a longer chain.

Controls whether operating-system CA roots are included when this object's trust configuration is activated. The default value is true.

On Windows, system roots come from registry-based certificate stores. On Linux, Chilkat may use a system CA bundle such as /etc/ssl/certs/ca-certificates.crt when available.

System roots are not added to this object's explicit collection and therefore are not included in NumCerts or returned by CertAt.

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.

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

Activates this object's trust configuration for Chilkat-wide certificate validation. The active configuration includes:

• Certificates explicitly added to this object by AddCert, AddJavaKeyStore, or LoadCaCertsPem.
• Operating-system CA roots when TrustSystemCaRoots is true.
• The self-signed TLS certificate policy selected by RejectSelfSignedCerts.

After activation, Chilkat classes that validate PKCS7/CMS signatures or SSL/TLS server certificate chains use this trust configuration. Returns true if the configuration was activated successfully; otherwise returns false.

Adds the certificate in cert to this object's explicit trusted-certificate collection. The certificate is subsequently treated as a trust anchor when this configuration is activated.

Returns true if the certificate was added successfully; otherwise returns false.

Adds the certificates designated as trusted entries in the keystore JavaKeyStore to this object's explicit trusted-certificate collection.

Private keys and secret keys are not imported. Returns true if the trusted certificates were added successfully; otherwise returns false.

Returns true for success, false for failure.

Creates an asynchronous task to call the AddJavaKeyStore method with the arguments provided.

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 null on failure

Copies the certificate at zero-based index into the caller-supplied Cert object in cert.

Valid indexes are from 0 through NumCerts - 1. Returns true if the certificate was retrieved successfully; otherwise returns false, such as when the index is outside the valid range.

This method enumerates only certificates explicitly contained in this TrustedRoots object. Operating-system roots enabled through TrustSystemCaRoots are not included.

Returns true for success, false for failure.

Deactivates the previously activated Chilkat-wide trusted-root configuration. After deactivation, roots and single-certificate self-signed certificates are implicitly trusted.

Returns true if the active configuration was deactivated successfully; otherwise returns false.

Returns true for success, false for failure.

Loads one or more PEM-encoded certificates from the file at path and adds them to this object's explicit trusted-certificate collection. A CA bundle normally contains consecutive -----BEGIN CERTIFICATE----- / -----END CERTIFICATE----- blocks.

This method can load a curated application bundle, a Mozilla-derived CA bundle, or a platform bundle such as /etc/ssl/certs/ca-certificates.crt when that file exists. Returns true if the bundle was loaded successfully; otherwise returns false.

Creates an asynchronous task to call the LoadCaCertsPem method with the arguments provided.

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 null on failure

Associates task with the object that initiated the task's asynchronous method call. This supports Chilkat's asynchronous task infrastructure and is not normally called directly by application code.

Returns true if the task caller was loaded successfully; otherwise returns false.

Returns true for success, false for failure.

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void trustedroots_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
trustedroots.OnAbortCheck += trustedroots_OnAbortCheck;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handleAbortCheck(out bool abort)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
// ...
Chilkat.TrustedRoots.AbortCheck abortCheck = new Chilkat.TrustedRoots.AbortCheck(handleAbortCheck);
trustedroots.setAbortCheckCb(abortCheck);

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.

Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void trustedroots_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
trustedroots.OnPercentDone += trustedroots_OnPercentDone;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handlePercentDone(int pctDone, out bool abort)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
// ...
Chilkat.TrustedRoots.PercentDone percentDone = new Chilkat.TrustedRoots.PercentDone(handlePercentDone);
trustedroots.setPercentDoneCb(percentDone);

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void trustedroots_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
trustedroots.OnProgressInfo += trustedroots_OnProgressInfo;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handleProgressInfo(string name, string value)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
// ...
Chilkat.TrustedRoots.ProgressInfo progressInfo = new Chilkat.TrustedRoots.ProgressInfo(handleProgressInfo);
trustedroots.setProgressInfoCb(progressInfo);

Called from the background thread when an asynchronous task completes.

Chilkat .NET Framework Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void trustedroots_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
trustedroots.OnTaskCompleted += trustedroots_OnTaskCompleted;

Chilkat .NET Core Event Implementation

Event callback implementation:

public void handleTaskIdCompleted(int taskId)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.TrustedRoots trustedroots = new Chilkat.TrustedRoots();
// ...
Chilkat.TrustedRoots.TaskIdCompleted taskIdCompleted = new Chilkat.TrustedRoots.TaskIdCompleted(handleTaskIdCompleted);
trustedroots.setTaskIdCompletedCb(taskIdCompleted);

Returns the certificate at zero-based index in this object's explicitly added certificate collection.

This method is deprecated. New applications should call CertAt, which returns an explicit success/failure result and stores the certificate in a caller-supplied Cert object.

Valid indexes are from 0 through NumCerts - 1. Operating-system roots enabled by TrustSystemCaRoots are not part of this indexed collection.

Returns null on failure