PrivateKey C# Reference Documentation
PrivateKey
Current Version: 10.0.0
Contains an RSA, DSA, or ECC private key. Provides methods for importing and exporting to/from PEM, DER, PKCS8, PKCS1, PVK, and XML formats. Private keys can be imported/exported to both memory and files.
Object Creation
Chilkat.PrivateKey obj = new Chilkat.PrivateKey();
Properties
BitLength
The bit length (strength) of the private key.
topDebugLogFilePath
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:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
KeyType
The type of private key. Can be "empty", "rsa", "dsa", "ecc" (i.e. ECDSA), or "ed25519".
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
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.
topPkcs8EncryptAlg
The encryption algorithm to be used when exporting the key to encrypted PKCS8. The default value is "3des". Possible choices also include "aes128", "aes192", and "aes256". All of the encryption algorithm choices use CBC mode.
topUncommonOptions
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string, and should typically remain empty.
topVerboseLogging
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.
topVersion
Methods
GetJwk
Gets the private key in JWK (JSON Web Key) format.
RSA keys have this JWK format:
{"kty":"RSA", "n":"0vx7agoebGcQ ... JzKnqDKgw", "e":"AQAB", "d":"X4cTteJY_gn4F ... 4jfcKoAC8Q", "p":"83i-7IvMGXoMX ... vn7O0nVbfs", "q":"3dfOR9cuYq-0S ... 4vIcb6yelxk", "dp":"G4sPXkc6Ya9 ... 8YeiKkTiBj0", "dq":"s9lAH9fggBso ... w494Q_cgk", "qi":"GyM_p6JrXySi ... zTKhAVRU"}
ECC keys have this JWK format.
{"kty":"EC", "crv":"P-256", "x":"MKBCTNIcKUSDii11ySs3526iDZ8AiTo7Tu6KPAqv7D4", "y":"4Etl6SRW2YiLUrN5vfvVHuhp7x8PxltmWWlbbM4IFyM", "d":"870MB6gfuTJ4HtUnUvYMyJpr5eUZNP4Bk43bVdj3eAE"}
Ed25519 keys (added in v9.5.0.83) have this JWK format.
{"kty": "OKP", "crv": "Ed25519", "x": "SE2Kne5xt51z1eciMH2T2ftDQp96Gl6FhY6zSQujiP0", "d": "O-eRXewadF0sNyB0U9omcnt8Qg2ZmeK3WSXPYgqe570", "use": "sig"}
Returns null on failure
GetJwkThumbprint
Returns the JWK thumbprint for the private key. This is the thumbprint of the JSON Web Key (JWK) as per RFC 7638.
Returns null on failure
GetPkcs1
Gets the private key in unencrypted binary DER format, preferring PKCS1 if possible.
RSA keys are returned in PKCS1 ASN.1 DER format:
RSAPrivateKey ::= SEQUENCE { version Version, modulus INTEGER, -- n publicExponent INTEGER, -- e privateExponent INTEGER, -- d prime1 INTEGER, -- p prime2 INTEGER, -- q exponent1 INTEGER, -- d mod (p-1) exponent2 INTEGER, -- d mod (q-1) coefficient INTEGER, -- (inverse of q) mod p otherPrimeInfos OtherPrimeInfos OPTIONAL }
DSA keys are returned in this ASN.1 DER format:
SEQUENCE(6 elem) INTEGER 0 INTEGER(2048 bit) (p) INTEGER(160 bit) (q) INTEGER(2044 bit) (g) INTEGER(2040 bit) (y - public key) INTEGER(156 bit) (x - private key)
ECC keys are returned in this ASN.1 DER format:
(from RFC 5915) ECPrivateKey ::= SEQUENCE { version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1), privateKey OCTET STRING, parameters [0] ECParameters {{ NamedCurve }} OPTIONAL, publicKey [1] BIT STRING OPTIONAL (This is the ANSI X9.63 public key format.)
Returns an empty byte array on failure
topGetPkcs1ENC
Gets the private key in unencrypted binary DER format, preferring PKCS1 if possible, and returns in an encoded string, as specified by the encoding argument.
RSA keys are returned in PKCS1 ASN.1 DER format:
RSAPrivateKey ::= SEQUENCE { version Version, modulus INTEGER, -- n publicExponent INTEGER, -- e privateExponent INTEGER, -- d prime1 INTEGER, -- p prime2 INTEGER, -- q exponent1 INTEGER, -- d mod (p-1) exponent2 INTEGER, -- d mod (q-1) coefficient INTEGER, -- (inverse of q) mod p otherPrimeInfos OtherPrimeInfos OPTIONAL }
DSA keys are returned in this ASN.1 DER format:
SEQUENCE(6 elem) INTEGER 0 INTEGER(2048 bit) (p) INTEGER(160 bit) (q) INTEGER(2044 bit) (g) INTEGER(2040 bit) (y - public key) INTEGER(156 bit) (x - private key)
ECC keys are returned in this ASN.1 DER format:
(from RFC 5915) ECPrivateKey ::= SEQUENCE { version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1), privateKey OCTET STRING, parameters [0] ECParameters {{ NamedCurve }} OPTIONAL, publicKey [1] BIT STRING OPTIONAL (This is the ANSI X9.63 public key format.)
Returns null on failure
GetPkcs1Pem
Gets the private key in non-encrypted PEM format, preferring PKCS1 over PKCS8 if possible for the key type.
Returns null on failure
topGetPkcs8
Gets the private key in unencrypted PKCS8 format.
RSA keys are returned in PKCS8 ASN.1 DER format:
SEQUENCE // PrivateKeyInfo +- INTEGER // Version - 0 (v1998) +- SEQUENCE // AlgorithmIdentifier +- OID // 1.2.840.113549.1.1.1 +- NULL // Optional Parameters +- OCTETSTRING // PrivateKey +- SEQUENCE // RSAPrivateKey +- INTEGER(0) // Version - v1998(0) +- INTEGER(N) // N +- INTEGER(E) // E +- INTEGER(D) // D +- INTEGER(P) // P +- INTEGER(Q) // Q +- INTEGER(DP) // d mod p-1 +- INTEGER(DQ) // d mod q-1 +- INTEGER(Inv Q) // INV(q) mod p
DSA keys are returned in this ASN.1 DER format:
SEQUENCE // PrivateKeyInfo +- INTEGER // Version +- SEQUENCE // AlgorithmIdentifier +- OID // 1.2.840.10040.4.1 +- SEQUENCE // DSS-Params (Optional Parameters) +- INTEGER(P) // P +- INTEGER(Q) // Q +- INTEGER(G) // G +- OCTETSTRING // PrivateKey +- INTEGER(X) // DSAPrivateKey X
ECC keys are returned in this ASN.1 DER format:
(from RFC 5915) ECPrivateKey ::= SEQUENCE { version INTEGER { ecPrivkeyVer1(1) } (ecPrivkeyVer1), privateKey OCTET STRING, parameters [0] ECParameters {{ NamedCurve }} OPTIONAL, publicKey [1] BIT STRING OPTIONAL (This is the ANSI X9.63 public key format.)
Returns an empty byte array on failure
topGetPkcs8ENC
Gets the private key in unencrypted PKCS8 format and returned in an encoded string, as specified by the encoding argument.
Returns null on failure
GetPkcs8Encrypted
Writes the private key to password-protected PKCS8 format. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.
Returns an empty byte array on failure
topGetPkcs8EncryptedENC
Writes the private key to password-protected PKCS8 format and returns as an encoded string as specified by the encoding argument. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.
Returns null on failure
GetPkcs8EncryptedPem
Writes the private key to password-protected PKCS8 PEM format. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.
Returns null on failure
GetPkcs8Pem
GetPublicKey
Returns the public key portion of the private key as a public key object.
Returns null on failure
GetRawHex
Returns the private key in raw hex format (lowercase). The public key is written to pubKey.
Ed25519 private and public keys are 32-byte each (64 chars in hex format).
The length of an EC key depends on the curve. The private key is a single hex string. The public key is a hex string composed of the "x" and "y" parts of the public key like this:
04||HEX(x)||HEX(y)
Note: This method is only applicable to Ed25519 and ECDSA keys. An RSA key cannot be returned in such as simple raw format because it is composed of multiple parts (modulus, exponent, and more).
Returns null on failure
GetXml
Returns the private key in XML format. The private key is returned unencrypted and the parts are base64 encoded.
RSA keys have this XML format:
<RSAKeyValue> <Modulus>...</Modulus> <Exponent>...</Exponent> <P>...</P> <Q>...</Q> <DP>...</DP> <DQ>...</DQ> <InverseQ>...</InverseQ> <D>...</D> </RSAKeyValue>
DSA keys have this XML format:
<DSAKeyValue> <P>...</P> <Q>...</Q> <G>...</G> <Y>...</Y> <X>...</X> </DSAKeyValue>
ECC keys have this XML format. The CURVE_NAME could be one of secp256r1, secp384r1, secp521r1, secp256k1 (or others as new curves are supported.)
<ECCKeyValue curve="CURVE_NAME">...</ECCKeyValue>
Returns null on failure
LoadAnyFormat
Loads a private key from any format (PKCS1, PKCS8, PEM, JWK, PVK, etc.). The contents of the key (binary or text) is passed in privKeyData. The password is optional and should be specified if needed.
Returns true for success, false for failure.
LoadAnyFormatFile
Loads a private key from a file in any format (PKCS1, PKCS8, PEM, JWK, PVK, etc.). The password is optional and should be specified if needed.
Returns true for success, false for failure.
topLoadEd25519
Loads the private key object with an ed25519 key pair. The privKey is the 32-byte private key as a hex string. The pubKey is the 32-byte public key as a hex string. pubKey may be an empty string, in which case the public key is automatically computed from the private key.
Returns true for success, false for failure.
LoadEncryptedPem
Loads the private key from an in-memory encrypted PEM string. An encrypted PEM contains the private key in encrypted PKCS#8 format, where the data begins and ends with the following tags:
-----BEGIN ENCRYPTED PRIVATE KEY----- BASE64 ENCODED DATA -----END ENCRYPTED PRIVATE KEY-----
For those requiring a deeper understanding: The base64 data contains ASN.1 DER with the following structure:
EncryptedPrivateKeyInfo ::= SEQUENCE { encryptionAlgorithm EncryptionAlgorithmIdentifier, encryptedData EncryptedData } EncryptionAlgorithmIdentifier ::= AlgorithmIdentifier EncryptedData ::= OCTET STRING
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
LoadEncryptedPemFile
Loads a private key from an encrypted PEM file.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
LoadJwk
Loads a private key from an JWK (JSON Web Key) string.
RSA keys have this JWK format:
{"kty":"RSA", "n":"0vx7agoebGcQ ... JzKnqDKgw", "e":"AQAB", "d":"X4cTteJY_gn4F ... 4jfcKoAC8Q", "p":"83i-7IvMGXoMX ... vn7O0nVbfs", "q":"3dfOR9cuYq-0S ... 4vIcb6yelxk", "dp":"G4sPXkc6Ya9 ... 8YeiKkTiBj0", "dq":"s9lAH9fggBso ... w494Q_cgk", "qi":"GyM_p6JrXySi ... zTKhAVRU"}
ECC keys have this JWK format.
{"kty":"EC", "crv":"P-256", "x":"MKBCTNIcKUSDii11ySs3526iDZ8AiTo7Tu6KPAqv7D4", "y":"4Etl6SRW2YiLUrN5vfvVHuhp7x8PxltmWWlbbM4IFyM", "d":"870MB6gfuTJ4HtUnUvYMyJpr5eUZNP4Bk43bVdj3eAE"}
Ed25519 keys (added in v9.5.0.83) have this JWK format.
{"kty": "OKP", "crv": "Ed25519", "x": "SE2Kne5xt51z1eciMH2T2ftDQp96Gl6FhY6zSQujiP0", "d": "O-eRXewadF0sNyB0U9omcnt8Qg2ZmeK3WSXPYgqe570", "use": "sig"}
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
LoadPem
Loads the private key from an in-memory PEM string. If the PEM contains an encrypted private key, then the LoadEncryptedPem method should instead be called. This method is for loading an unencrypted private key stored in PEM using PKCS#1 or PKCS#8.
A private key stored in PKCS#1 format begins and ends with the tags:
-----BEGIN RSA PRIVATE KEY----- BASE64 ENCODED DATA -----END RSA PRIVATE KEY-----
For those requiring a deeper understanding, the PKCS1 base64 contains ASN.1 in DER encoding with the following structure:
RSAPrivateKey ::= SEQUENCE { version Version, modulus INTEGER, -- n publicExponent INTEGER, -- e privateExponent INTEGER, -- d prime1 INTEGER, -- p prime2 INTEGER, -- q exponent1 INTEGER, -- d mod (p-1) exponent2 INTEGER, -- d mod (q-1) coefficient INTEGER, -- (inverse of q) mod p otherPrimeInfos OtherPrimeInfos OPTIONAL }
A private key stored in PKCS#8 format begins and ends with the tags:
-----BEGIN PRIVATE KEY----- BASE64 ENCODED DATA -----END PRIVATE KEY-----
For those requiring a deeper understanding, the PKCS8 base64 contains ASN.1 in DER encoding with the following structure:
PrivateKeyInfo ::= SEQUENCE { version Version, algorithm AlgorithmIdentifier, PrivateKey BIT STRING } AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL }
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
LoadPemFile
Loads a private key from a PEM file.
Returns true for success, false for failure.
LoadPkcs1
Loads an RSA, ECC, or DSA private key from binary DER.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topLoadPkcs1File
Loads a private key from a PKCS1 file.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topLoadPkcs8
Loads a private key from in-memory PKCS8 byte data.
For those requiring a deeper understanding, the PKCS8 contains ASN.1 in DER encoding with the following structure:
PrivateKeyInfo ::= SEQUENCE { version Version, algorithm AlgorithmIdentifier, PrivateKey BIT STRING } AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL }
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topLoadPkcs8Encrypted
Loads a private key from in-memory password-protected PKCS8 byte data.
For those requiring a deeper understanding, the encrypted PKCS8 contains ASN.1 in DER encoding with the following structure:
EncryptedPrivateKeyInfo ::= SEQUENCE { encryptionAlgorithm EncryptionAlgorithmIdentifier, encryptedData EncryptedData } EncryptionAlgorithmIdentifier ::= AlgorithmIdentifier EncryptedData ::= OCTET STRING
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topLoadPkcs8EncryptedFile
Loads a private key from an encrypted PKCS8 file.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
LoadPkcs8File
Loads a private key from a PKCS8 file.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topLoadPvk
Loads a private key from in-memory PVK byte data.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topLoadPvkFile
Loads a private key from a PVK format file.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
LoadXml
Loads a private key from an XML string.
RSA keys have this XML format:
<RSAKeyValue> <Modulus>...</Modulus> <Exponent>...</Exponent> <P>...</P> <Q>...</Q> <DP>...</DP> <DQ>...</DQ> <InverseQ>...</InverseQ> <D>...</D> </RSAKeyValue>
DSA keys have this XML format:
<DSAKeyValue> <P>...</P> <Q>...</Q> <G>...</G> <Y>...</Y> <X>...</X> </DSAKeyValue>
ECC keys have this XML format. The CURVE_NAME could be one of secp256r1, secp384r1, secp521r1, secp256k1 (or others as new curves are supported.)
<ECCKeyValue curve="CURVE_NAME">...</ECCKeyValue>
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topLoadXmlFile
Loads a private key from an XML file.
Note: Each of the private key Load* methods willl auto-recognize the content and will parse appropriately. The private key should be successfully loaded even when the wrong format data is passed to the wrong method.
Returns true for success, false for failure.
topSavePemFile
Saves the private key to an unencrypted PKCS1 PEM format file.
Returns true for success, false for failure.
topSavePkcs1File
Saves the private key to an unencrypted binary PKCS1 format file.
Returns true for success, false for failure.
topSavePkcs8EncryptedFile
Saves the private key to a password-protected PKCS8 format file. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.
Returns true for success, false for failure.
topSavePkcs8EncryptedPemFile
Saves the private key to a password-protected PKCS8 PEM format file. The Pkcs8EncryptAlg property controls the encryption algorithm used to encrypt.
Returns true for success, false for failure.
SavePkcs8File
Saves the private key to an unencrypted binary PKCS8 format file.
Returns true for success, false for failure.
topSavePkcs8PemFile
SaveXmlFile
UploadToCloud
This is an open-ended method to accomodate uploading the private key to a cloud service, such as AWS KMS, or Azure Key Vault. For details, see the examples below.
Returns true for success, false for failure.
topUploadToCloudAsync (.NET Core C#) (C#) (Mono C#) (PowerShell)
Creates an asynchronous task to call the UploadToCloud 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 null on failure
topEvents
AbortCheck
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.
Chilkat .NET Event Implementation
Args are passed using Chilkat.AbortCheckEventArgs
Event callback implementation:
private void privatekey_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args) { // application code goes here. }
To add an event handler:
Chilkat.PrivateKey privatekey = new Chilkat.PrivateKey(); privatekey.OnAbortCheck += privatekey_OnAbortCheck;
Chilkat Mono/.NET Core Event Implementation
Event callback implementation:
public void handleAbortCheck(out bool abort) { // application code goes here. }
To add an event handler:
Chilkat.PrivateKey privatekey = new Chilkat.PrivateKey(); // ... Chilkat.PrivateKey.AbortCheck abortCheck = new Chilkat.PrivateKey.AbortCheck(handleAbortCheck); privatekey.setAbortCheckCb(abortCheck);
PercentDone
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 true will cause the method to abort and return a failed status (or whatever return value indicates failure).
Chilkat .NET Event Implementation
Args are passed using Chilkat.PercentDoneEventArgs
Event callback implementation:
private void privatekey_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args) { // application code goes here. }
To add an event handler:
Chilkat.PrivateKey privatekey = new Chilkat.PrivateKey(); privatekey.OnPercentDone += privatekey_OnPercentDone;
Chilkat Mono/.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.PrivateKey privatekey = new Chilkat.PrivateKey(); // ... Chilkat.PrivateKey.PercentDone percentDone = new Chilkat.PrivateKey.PercentDone(handlePercentDone); privatekey.setPercentDoneCb(percentDone);
ProgressInfo
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.
Chilkat .NET Event Implementation
Args are passed using Chilkat.ProgressInfoEventArgs
Event callback implementation:
private void privatekey_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args) { // application code goes here. }
To add an event handler:
Chilkat.PrivateKey privatekey = new Chilkat.PrivateKey(); privatekey.OnProgressInfo += privatekey_OnProgressInfo;
Chilkat Mono/.NET Core Event Implementation
Event callback implementation:
public void handleProgressInfo(string name, string value) { // application code goes here. }
To add an event handler:
Chilkat.PrivateKey privatekey = new Chilkat.PrivateKey(); // ... Chilkat.PrivateKey.ProgressInfo progressInfo = new Chilkat.PrivateKey.ProgressInfo(handleProgressInfo); privatekey.setProgressInfoCb(progressInfo);
TaskCompleted
Called in the background thread when an asynchronous task completes.
Chilkat .NET Event Implementation
Args are passed using Chilkat.TaskCompletedEventArgs
Event callback implementation:
private void privatekey_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args) { // application code goes here. }
To add an event handler:
Chilkat.PrivateKey privatekey = new Chilkat.PrivateKey(); privatekey.OnTaskCompleted += privatekey_OnTaskCompleted;
Chilkat Mono/.NET Core Event Implementation
Event callback implementation:
public void handleTaskIdCompleted(int taskId) { // application code goes here. }
To add an event handler:
Chilkat.PrivateKey privatekey = new Chilkat.PrivateKey(); // ... Chilkat.PrivateKey.TaskIdCompleted taskIdCompleted = new Chilkat.PrivateKey.TaskIdCompleted(handleTaskIdCompleted); privatekey.setTaskIdCompletedCb(taskIdCompleted);