CkCreateCS Perl Reference Documentation

CkCreateCS

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.

Object Creation

$obj = chilkat::CkCreateCS()->new();

Properties

DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$createCS->get_DebugLogFilePath($ckStr);
$strVal = $createCS->debugLogFilePath();
$createCS->put_DebugLogFilePath($strVal);

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
# $strVal is a string
# $ckStr is a CkString
$createCS->get_LastErrorHtml($ckStr);
$strVal = $createCS->lastErrorHtml();

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
# $strVal is a string
# $ckStr is a CkString
$createCS->get_LastErrorText($ckStr);
$strVal = $createCS->lastErrorText();

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
# $strVal is a string
# $ckStr is a CkString
$createCS->get_LastErrorXml($ckStr);
$strVal = $createCS->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.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $createCS->get_LastMethodSuccess();
$createCS->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

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.

top
ReadOnly
# $boolVal is a boolean
$boolVal = $createCS->get_ReadOnly();
$createCS->put_ReadOnly($boolVal);

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
# $boolVal is a boolean
$boolVal = $createCS->get_Utf8();
$createCS->put_Utf8($boolVal);

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

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $createCS->get_VerboseLogging();
$createCS->put_VerboseLogging($boolVal);

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.

top
Version
# $strVal is a string
# $ckStr is a CkString
$createCS->get_Version($ckStr);
$strVal = $createCS->version();

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

top

Methods

CreateFileStore
# returns a CkCertStore
# $path is a string
$ret_certStore = $createCS->CreateFileStore($path);

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

Returns null on failure

top
CreateMemoryStore
# returns a CkCertStore
$ret_certStore = $createCS->CreateMemoryStore();

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

Returns null on failure

top
CreateRegistryStore
# returns a CkCertStore
# $regRoot is a string
# $regPath is a string
$ret_certStore = $createCS->CreateRegistryStore($regRoot, $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
# returns a CkCertStore
$ret_certStore = $createCS->OpenChilkatStore();

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

Returns null on failure

top
OpenCurrentUserStore
# returns a CkCertStore
$ret_certStore = $createCS->OpenCurrentUserStore();

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

Returns null on failure

top
OpenFileStore
# returns a CkCertStore
# $path is a string
$ret_certStore = $createCS->OpenFileStore($path);

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

Returns null on failure

top
OpenLocalSystemStore
# returns a CkCertStore
$ret_certStore = $createCS->OpenLocalSystemStore();

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

Returns null on failure

top
OpenOutlookStore
# returns a CkCertStore
$ret_certStore = $createCS->OpenOutlookStore();

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

Returns null on failure

top
OpenRegistryStore
# returns a CkCertStore
# $regRoot is a string
# $regPath is a string
$ret_certStore = $createCS->OpenRegistryStore($regRoot, $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
# $path is a string
$status = $createCS->SaveLastError($path);

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

Returns 1 for success, 0 for failure.

top