init()

This function initializes a Panopticon session. If initialization is successful, the pointer that context points to is set to a valid context identifier. You must pass this context identifier as the first parameter to all other Panopticon functions.

Syntax

KVPanopticonError init(
    const char* const binDir,
    const char* const tempFolder,
    const char* const license,
    KVPanopticonContext** const context /*out*/
);

Arguments

binDir

A null-terminated C string that contains the path of the directory where the Panopticon components are located.

tempFolder

(Optional) A null-terminated C string that contains the path of directory to use to store temporary files. Set this value to NULL to default to the system temporary directory.

license A pointer to a string that contains your license key, as provided by OpenText. Copy the key exactly, with no leading or trailing spaces.
context A valid pointer to a NULL pointer of type KVPanopticonContext. If initialization is successful, this target is set to a context-identifying value, which you must supply to subsequent Panopticon functions.

Returns

If the function was successful, it returns KVP_Success. Otherwise, it returns a KVPanopticonError value describing the problem.