TChilkatCsp Delphi ActiveX Reference Documentation
TChilkatCsp
Current Version: 10.1.0
Note: This class is deprecated and should no longer be used.
Represents a cryptographic service provider for selecting encryption, hashing, and digital signing algorithms.
This class is specific to the Windows operating system, and therefore is only available on Windows systems.
Importing the Chilkat ActiveX into Delphi
Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.
Chilkat v9.5.*: If using Chilkat v9.5.*, then use "Chilkat_v9_5_0_TLB" instead of "Chilkat_TLB", and the DLLs are named ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll).
Two things are required to use an ActiveX in Delphi:
- The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
- See also: ActiveX Registration Tutorial
- The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_TLB.pas and Chilkat_TLB.dcr. The Chilkat_TLB.pas should be added to your project.
To import the Chilkat type library, do the following:
- In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
- Find "Chilkat ActiveX" in the list and select it. This will only appear in the list if the ChilkatAx-win32.dll (or ChilkatAx-x64.dll) has been registered w/ regsvr32.
- Check the "Generate Component Wrappers" checkbox.
- Select a directory where the unit files (.pas and .dcr) should be generated.
- Select "Create Unit" and then "Finish".
- Add the .pas to your Delphi project.
To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_TLB" to the "uses" statement. For example:
uses Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics, Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;
Object Creation
var obj: TChilkatCsp; ... begin obj := TChilkatCsp.Create(Self); ... // When finished, free the object instance. obj.Free();
Properties
DebugLogFilePath
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.
EncryptAlgorithm
Returns the name of the currently selected encryption algorithm in the currently selected CSP.
topEncryptAlgorithmID
Returns the ID of the currently selected encryption algorithm in the currently selected CSP.
topEncryptNumBits
Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.
topHashAlgorithm
Returns the name of the currently selected hash algorithm in the currently selected CSP.
topHashAlgorithmID
Returns the ID of the currently selected hash algorithm in the currently selected CSP.
topHashNumBits
Returns the bit length of the currently selected hash algorithm in the currently selected CSP.
topLastBinaryResult
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).
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 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.
topLastStringResult
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).
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumEncryptAlgorithms
The number of encryption algorithms provided by the currently selected CSP.
topNumHashAlgorithms
The number of hash algorithms provided by the currently selected CSP.
topNumKeyContainers
The number of key containers provided by the currently selected CSP.
topNumKeyExchangeAlgorithms
The number of key exchange algorithms provided by the currently selected CSP.
topNumSignatureAlgorithms
The number of signature algorithms provided by the currently selected CSP.
topProviderName
The currently selected CSP. To select another CSP, simply set this property to the name of the CSP, such as "Microsoft Enhanced Cryptographic Provider v1.0". If the CSP is not available on your machine, the property value will not change. The initial and default value for this property is "Microsoft Base Cryptographic Provider v1.0".
topProviderType
This is an integer representing the type of CSP. (Chilkat uses it for internal use.)
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 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.
topVersion
Methods
HasEncryptAlgorithm
Returns true if the currently selected CSP contains an encryption algorithm matching the name and key length. Otherwise returns false.
topHasHashAlgorithm
Returns 1 if the currently selected CSP contains a hash algorithm matching the name and bit length. Otherwise returns 0
topInitialize
Intializes the Csp with the selected ProviderName.
topNthEncryptionAlgorithm
Returns the name of the Nth encryption algorithm provided by the currently selected CSP. Indexing begins at 0.
Returns a zero-length WideString on failure
topNthEncryptionNumBits
Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.
topNthHashAlgorithmName
NthHashNumBits
Returns the bit length of the Nth hash algorithm provided by the currently selected CSP. Indexing begins at 0.
topNthKeyContainerName
Returns the Nth key container name in the currently selected CSP. Indexing begins at 0.
Returns a zero-length WideString on failure
NthKeyExchangeAlgorithm
Returns the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.
Returns a zero-length WideString on failure
topNthKeyExchangeNumBits
Returns the bit length of the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.
topNthSignatureAlgorithm
Returns the name of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.
Returns a zero-length WideString on failure
topNthSignatureNumBits
Returns the bit length of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.
topSetEncryptAlgorithm
Selects an encryption algorithm. The return value is the key-length of the algorithm. If the algorithm is not available, the return value is 0. (There usually is not a need to explicitly select the key length, because the key length can be part of the name, such as "AES 128", or it is determined by the CSP. For example, the Microsoft Enhanced CSP will return a 128-bit key length for RC2, whereas the Base CSP will return a 40-bit key length.)
topSetHashAlgorithm
Selects a hash algorithm. The return value is the bit-length of the algorithm. If the algorithm is not available, the return value is 0.
top