CreateCS Delphi DLL Reference Documentation
CreateCS
Current Version: 9.5.0.98
Factory class for creating certificate store objects.
This class is specific to the Windows operating system, and therefore is only available on Windows systems.
Create/Dispose
var myObject: HCkCreateCS; begin myObject := CkCreateCS_Create(); // ... CkCreateCS_Dispose(myObject); end;
Creates an instance of the HCkCreateCS object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkCreateCS_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 CkCreateCS_putDebugLogFilePath(objHandle: HCkCreateCS; newPropVal: PWideChar); stdcall;
function CkCreateCS__debugLogFilePath(objHandle: HCkCreateCS): 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.
LastErrorHtml
function CkCreateCS__lastErrorHtml(objHandle: HCkCreateCS): 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.
topLastErrorText
function CkCreateCS__lastErrorText(objHandle: HCkCreateCS): 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.
LastErrorXml
function CkCreateCS__lastErrorXml(objHandle: HCkCreateCS): 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.
topLastMethodSuccess
procedure CkCreateCS_putLastMethodSuccess(objHandle: HCkCreateCS; 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.
topReadOnly
procedure CkCreateCS_putReadOnly(objHandle: HCkCreateCS; newPropVal: wordbool); stdcall;
Determines whether certificate stores are opened with read-only or read/write permissions. Only applies to methods such as OpenCurrentUserStore, where the a readOnly parameter is not present.
topVerboseLogging
procedure CkCreateCS_putVerboseLogging(objHandle: HCkCreateCS; 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.
topVersion
function CkCreateCS__version(objHandle: HCkCreateCS): PWideChar; stdcall;
Methods
CreateFileStore
path: PWideChar): HCkCertStore; stdcall;
Creates a file-based certificate store. If 'filename' already exists, the method will fail.
Returns nil on failure
topCreateMemoryStore
CreateRegistryStore
regRoot: PWideChar;
regPath: PWideChar): HCkCertStore; stdcall;
Creates a registry-based certificate store. The 'hiveName' can either be "CurrentUser" or "LocalMachine". The 'regPath' argument should be specified without a leading slash, such as "Software/Chilkat/MyCertStore".
Returns nil on failure
topOpenChilkatStore
Opens the certificate store used by Chilkat Mail and returns the object representing that store.
Returns nil on failure
topOpenCurrentUserStore
Opens the local system's Current User Certificate Store and returns the object representing that store.
Returns nil on failure
topOpenFileStore
Opens an existing file certificate store. To open it read-only, readOnly should be non-zero.
Returns nil on failure
topOpenLocalSystemStore
Opens the local system's Local Machine Certificate Store and returns the object representing that store.
Returns nil on failure
topOpenOutlookStore
Opens the certificate store used by Microsoft Outlook (and Office) and returns the object representing that store.
Returns nil on failure
topOpenRegistryStore
regRoot: PWideChar;
regPath: PWideChar): HCkCertStore; stdcall;
Opens an existing registry-based certificate store. 'hiveName' should be either "CurrentUser" or "LocalMachine". The 'regPath' argument should be specified without a leading slash, such as "Software/Chilkat/MyCertStore".
Returns nil on failure
top