Csp Delphi DLL Reference Documentation

Csp

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.

Create/Dispose

var
myObject: HCkCsp;

begin
myObject := CkCsp_Create();

// ...

CkCsp_Dispose(myObject);
end;

function CkCsp_Create: HCkCsp; stdcall;

Creates an instance of the HCkCsp object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkCsp_Dispose(handle: HCkCsp); stdcall;

Objects created by calling CkCsp_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

DebugLogFilePath

procedure CkCsp_getDebugLogFilePath(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
procedure CkCsp_putDebugLogFilePath(objHandle: HCkCsp; newPropVal: PWideChar); stdcall;
function CkCsp__debugLogFilePath(objHandle: HCkCsp): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

EncryptAlgorithm

procedure CkCsp_getEncryptAlgorithm(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
function CkCsp__encryptAlgorithm(objHandle: HCkCsp): PWideChar; stdcall;

Returns the name of the currently selected encryption algorithm in the currently selected CSP.

See the notes about PWideChar memory ownership and validity.

EncryptAlgorithmID

function CkCsp_getEncryptAlgorithmID(objHandle: HCkCsp): Integer; stdcall;

Returns the ID of the currently selected encryption algorithm in the currently selected CSP.

EncryptNumBits

function CkCsp_getEncryptNumBits(objHandle: HCkCsp): Integer; stdcall;

Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.

HashAlgorithm

procedure CkCsp_getHashAlgorithm(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
function CkCsp__hashAlgorithm(objHandle: HCkCsp): PWideChar; stdcall;

Returns the name of the currently selected hash algorithm in the currently selected CSP.

See the notes about PWideChar memory ownership and validity.

HashAlgorithmID

function CkCsp_getHashAlgorithmID(objHandle: HCkCsp): Integer; stdcall;

Returns the ID of the currently selected hash algorithm in the currently selected CSP.

HashNumBits

function CkCsp_getHashNumBits(objHandle: HCkCsp): Integer; stdcall;

Returns the bit length of the currently selected hash algorithm in the currently selected CSP.

LastErrorHtml

procedure CkCsp_getLastErrorHtml(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
function CkCsp__lastErrorHtml(objHandle: HCkCsp): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkCsp_getLastErrorText(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
function CkCsp__lastErrorText(objHandle: HCkCsp): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkCsp_getLastErrorXml(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
function CkCsp__lastErrorXml(objHandle: HCkCsp): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkCsp_getLastMethodSuccess(objHandle: HCkCsp): wordbool; stdcall;
procedure CkCsp_putLastMethodSuccess(objHandle: HCkCsp; newPropVal: wordbool); stdcall;

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.

NumEncryptAlgorithms

function CkCsp_getNumEncryptAlgorithms(objHandle: HCkCsp): Integer; stdcall;

The number of encryption algorithms provided by the currently selected CSP.

NumHashAlgorithms

function CkCsp_getNumHashAlgorithms(objHandle: HCkCsp): Integer; stdcall;

The number of hash algorithms provided by the currently selected CSP.

NumKeyContainers

function CkCsp_getNumKeyContainers(objHandle: HCkCsp): Integer; stdcall;

The number of key containers provided by the currently selected CSP.

NumKeyExchangeAlgorithms

function CkCsp_getNumKeyExchangeAlgorithms(objHandle: HCkCsp): Integer; stdcall;

The number of key exchange algorithms provided by the currently selected CSP.

NumSignatureAlgorithms

function CkCsp_getNumSignatureAlgorithms(objHandle: HCkCsp): Integer; stdcall;

The number of signature algorithms provided by the currently selected CSP.

ProviderName

procedure CkCsp_getProviderName(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
procedure CkCsp_putProviderName(objHandle: HCkCsp; newPropVal: PWideChar); stdcall;
function CkCsp__providerName(objHandle: HCkCsp): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

ProviderType

function CkCsp_getProviderType(objHandle: HCkCsp): Integer; stdcall;

This is an integer representing the type of CSP. (Chilkat uses it for internal use.)

UncommonOptions

procedure CkCsp_getUncommonOptions(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
procedure CkCsp_putUncommonOptions(objHandle: HCkCsp; newPropVal: PWideChar); stdcall;
function CkCsp__uncommonOptions(objHandle: HCkCsp): PWideChar; stdcall;

Introduced in version 9.5.0.83

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

See the notes about PWideChar memory ownership and validity.

VerboseLogging

function CkCsp_getVerboseLogging(objHandle: HCkCsp): wordbool; stdcall;
procedure CkCsp_putVerboseLogging(objHandle: HCkCsp; newPropVal: wordbool); stdcall;

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

procedure CkCsp_getVersion(objHandle: HCkCsp; outPropVal: HCkString); stdcall;
function CkCsp__version(objHandle: HCkCsp): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

HasEncryptAlgorithm

function CkCsp_HasEncryptAlgorithm(objHandle: HCkCsp;
name: PWideChar;
numBits: Integer): wordbool; stdcall;

Returns true if the currently selected CSP contains an encryption algorithm matching the name and key length. Otherwise returns false.

HasHashAlgorithm

function CkCsp_HasHashAlgorithm(objHandle: HCkCsp;
name: PWideChar;
numBits: Integer): wordbool; stdcall;

Returns True if the currently selected CSP contains a hash algorithm matching the name and bit length. Otherwise returns False

Initialize

function CkCsp_Initialize(objHandle: HCkCsp): wordbool; stdcall;

Intializes the Csp with the selected ProviderName.

NthEncryptionAlgorithm

function CkCsp_NthEncryptionAlgorithm(objHandle: HCkCsp;
    index: Integer;
    outName: HCkString): wordbool; stdcall;
function CkCsp__nthEncryptionAlgorithm(objHandle: HCkCsp;
    index: Integer): PWideChar; stdcall;

Returns the name of the Nth encryption algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

NthEncryptionNumBits

function CkCsp_NthEncryptionNumBits(objHandle: HCkCsp;
index: Integer): Integer; stdcall;

Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.

NthHashAlgorithmName

function CkCsp_NthHashAlgorithmName(objHandle: HCkCsp;
    index: Integer;
    outName: HCkString): wordbool; stdcall;
function CkCsp__nthHashAlgorithmName(objHandle: HCkCsp;
    index: Integer): PWideChar; stdcall;

To be documented soon...

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

NthHashNumBits

function CkCsp_NthHashNumBits(objHandle: HCkCsp;
index: Integer): Integer; stdcall;

Returns the bit length of the Nth hash algorithm provided by the currently selected CSP. Indexing begins at 0.

NthKeyContainerName

function CkCsp_NthKeyContainerName(objHandle: HCkCsp;
    index: Integer;
    outName: HCkString): wordbool; stdcall;
function CkCsp__nthKeyContainerName(objHandle: HCkCsp;
    index: Integer): PWideChar; stdcall;

Returns the Nth key container name in the currently selected CSP. Indexing begins at 0.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Find Certificate on Smartcard Currenty in Reader

NthKeyExchangeAlgorithm

function CkCsp_NthKeyExchangeAlgorithm(objHandle: HCkCsp;
    index: Integer;
    outName: HCkString): wordbool; stdcall;
function CkCsp__nthKeyExchangeAlgorithm(objHandle: HCkCsp;
    index: Integer): PWideChar; stdcall;

Returns the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

NthKeyExchangeNumBits

function CkCsp_NthKeyExchangeNumBits(objHandle: HCkCsp;
index: Integer): Integer; stdcall;

Returns the bit length of the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.

NthSignatureAlgorithm

function CkCsp_NthSignatureAlgorithm(objHandle: HCkCsp;
    index: Integer;
    outName: HCkString): wordbool; stdcall;
function CkCsp__nthSignatureAlgorithm(objHandle: HCkCsp;
    index: Integer): PWideChar; stdcall;

Returns the name of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

NthSignatureNumBits

function CkCsp_NthSignatureNumBits(objHandle: HCkCsp;
index: Integer): Integer; stdcall;

Returns the bit length of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.

SetEncryptAlgorithm

function CkCsp_SetEncryptAlgorithm(objHandle: HCkCsp;
name: PWideChar): Integer; stdcall;

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

SetHashAlgorithm

function CkCsp_SetHashAlgorithm(objHandle: HCkCsp;
name: PWideChar): Integer; stdcall;

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.