CreateCS DataFlex 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.

Object Creation

// (Dataflex programs use the 32-bit Chilkat ActiveX)
Handle hoCreateCS
Get Create(RefClass(cComChilkatCreateCS)) to hoCreateCS

Properties

DebugLogFilePath
Function ComDebugLogFilePath Returns String
Procedure Set ComDebugLogFilePath String value

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
LastBinaryResult
Function ComLastBinaryResult Returns Variant
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to True. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
Function ComLastErrorHtml Returns String

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
Function ComLastErrorText Returns String

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
Function ComLastErrorXml Returns String

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
Function ComLastMethodSuccess Returns Boolean
Procedure Set ComLastMethodSuccess Boolean value
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
LastStringResult
Function ComLastStringResult Returns String
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to True. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
Function ComLastStringResultLen Returns Integer
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
ReadOnly
Function ComReadOnly Returns Boolean
Procedure Set ComReadOnly Boolean value

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
VerboseLogging
Function ComVerboseLogging Returns Boolean
Procedure Set ComVerboseLogging Boolean value

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
Function ComVersion Returns String

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

top

Methods

CreateFileStore
Function ComCreateFileStore String path Returns cComChilkatCertStore

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

Returns null on failure

top
CreateMemoryStore
Function ComCreateMemoryStore Returns cComChilkatCertStore

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

Returns null on failure

top
CreateRegistryStore
Function ComCreateRegistryStore String regRoot String regPath Returns cComChilkatCertStore

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
Function ComOpenChilkatStore Returns cComChilkatCertStore

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

Returns null on failure

top
OpenCurrentUserStore
Function ComOpenCurrentUserStore Returns cComChilkatCertStore

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

Returns null on failure

top
OpenFileStore
Function ComOpenFileStore String path Returns cComChilkatCertStore

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

Returns null on failure

top
OpenLocalSystemStore
Function ComOpenLocalSystemStore Returns cComChilkatCertStore

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

Returns null on failure

top
OpenOutlookStore
Function ComOpenOutlookStore Returns cComChilkatCertStore

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

Returns null on failure

top
OpenRegistryStore
Function ComOpenRegistryStore String regRoot String regPath Returns cComChilkatCertStore

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