CreateCS C Reference Documentation

CreateCS

Current Version: 9.5.0.73

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

HCkCreateCS instance = CkCreateCS_Create();
// ...
CkCreateCS_Dispose(instance);
HCkCreateCS CkCreateCS_Create(void);

Creates an instance of the HCkCreateCS object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkCreateCS_Dispose(HCkCreateCS handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkCreateCS_Dispose.

Properties

DebugLogFilePath
void CkCreateCS_getDebugLogFilePath(HCkCreateCS cHandle, HCkString retval);
void CkCreateCS_putDebugLogFilePath(HCkCreateCS cHandle, const char *newVal);
const char *CkCreateCS_debugLogFilePath(HCkCreateCS cHandle);

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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
LastErrorHtml
void CkCreateCS_getLastErrorHtml(HCkCreateCS cHandle, HCkString retval);
const char *CkCreateCS_lastErrorHtml(HCkCreateCS cHandle);

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.

top
LastErrorText
void CkCreateCS_getLastErrorText(HCkCreateCS cHandle, HCkString retval);
const char *CkCreateCS_lastErrorText(HCkCreateCS cHandle);

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.

top
LastErrorXml
void CkCreateCS_getLastErrorXml(HCkCreateCS cHandle, HCkString retval);
const char *CkCreateCS_lastErrorXml(HCkCreateCS cHandle);

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.

top
LastMethodSuccess
BOOL CkCreateCS_getLastMethodSuccess(HCkCreateCS cHandle);
void CkCreateCS_putLastMethodSuccess(HCkCreateCS cHandle, BOOL newVal);
Introduced in version 9.5.0.52

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.

top
ReadOnly
BOOL CkCreateCS_getReadOnly(HCkCreateCS cHandle);
void CkCreateCS_putReadOnly(HCkCreateCS cHandle, BOOL newVal);

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.

top
Utf8
BOOL CkCreateCS_getUtf8(HCkCreateCS cHandle);
void CkCreateCS_putUtf8(HCkCreateCS cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkCreateCS_getVerboseLogging(HCkCreateCS cHandle);
void CkCreateCS_putVerboseLogging(HCkCreateCS cHandle, BOOL newVal);

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.

top
Version
void CkCreateCS_getVersion(HCkCreateCS cHandle, HCkString retval);
const char *CkCreateCS_version(HCkCreateCS cHandle);

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

top

Methods

CreateFileStore
HCkCertStore CkCreateCS_CreateFileStore(HCkCreateCS cHandle, const char *path);

Creates a file-based certificate store. If 'filename' already exists, the method will fail.

Returns NULL on failure

top
CreateMemoryStore
HCkCertStore CkCreateCS_CreateMemoryStore(HCkCreateCS cHandle);

Creates a temporary certificate store in memory that is initially empty.

Returns NULL on failure

top
CreateRegistryStore
HCkCertStore CkCreateCS_CreateRegistryStore(HCkCreateCS cHandle, const char *regRoot, const char *regPath);

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

top
OpenChilkatStore
HCkCertStore CkCreateCS_OpenChilkatStore(HCkCreateCS cHandle);

Opens the certificate store used by Chilkat Mail and returns the object representing that store.

Returns NULL on failure

top
OpenCurrentUserStore
HCkCertStore CkCreateCS_OpenCurrentUserStore(HCkCreateCS cHandle);

Opens the local system's Current User Certificate Store and returns the object representing that store.

Returns NULL on failure

top
OpenFileStore
HCkCertStore CkCreateCS_OpenFileStore(HCkCreateCS cHandle, const char *path);

Opens an existing file certificate store. To open it read-only, readOnly should be non-zero.

Returns NULL on failure

top
OpenLocalSystemStore
HCkCertStore CkCreateCS_OpenLocalSystemStore(HCkCreateCS cHandle);

Opens the local system's Local Machine Certificate Store and returns the object representing that store.

Returns NULL on failure

top
OpenOutlookStore
HCkCertStore CkCreateCS_OpenOutlookStore(HCkCreateCS cHandle);

Opens the certificate store used by Microsoft Outlook (and Office) and returns the object representing that store.

Returns NULL on failure

top
OpenRegistryStore
HCkCertStore CkCreateCS_OpenRegistryStore(HCkCreateCS cHandle, const char *regRoot, const char *regPath);

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

top
SaveLastError
BOOL CkCreateCS_SaveLastError(HCkCreateCS cHandle, const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top