CkCreateCS Perl Programming
Reference Documentation

CkCreateCS

Factory class for creating certificate store objects.

Properties

# str is a CkString object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

# str is a CkString object (output)
LastErrorText( str )

Error information in plain-text format for the last method called.

# str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

# Returns a boolean value
get_ReadOnly( )

# newVal is a boolean (input)
put_ReadOnly( 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.

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.

# version is a CkString object (output)
get_Version( version )

The version of this component, such as "1.0"

Methods

# filename is a string (input)
# Returns a CkCertStore object
CreateFileStore( filename )

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

# Returns a CkCertStore object
CreateMemoryStore( )

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

# regRoot is a string (input)
# regPath is a string (input)
# Returns a CkCertStore object
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 a CkCertStore object
OpenChilkatStore( )

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

# Returns a CkCertStore object
OpenCurrentUserStore( )

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

# filename is a string (input)
# Returns a CkCertStore object
OpenFileStore( filename )

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

# Returns a CkCertStore object
OpenLocalSystemStore( )

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

# Returns a CkCertStore object
OpenOutlookStore( )

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

# regRoot is a string (input)
# regPath is a string (input)
# Returns a CkCertStore object
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".

# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

# Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.

# Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.

# Returns a string
lastErrorXml( )

Error information in XML format for the last method called.