fpInit()

This function initializes an Export session. Its return value, pContext, is passed as the first parameter to the File Extraction interface and all other Export functions.

DEPRECATED: The fpInit() function is deprecated in KeyView 12.7.0 and later. Micro Focus recommends that you use fpInitWithLicenseData() instead, so that your license key is passed to KeyView through the API. You should not include license information in your application as a file (kv.lic).

This function is still available for existing implementations, but it might be incompatible with new functionality. The function might be removed in future.

Syntax

void* pascal _export fpInit(
    KVMemoryStream    *pMemAllocator,
    char              *pszKeyViewDir,
    char              *pszDataFile,
    KVErrorCode       *pError,
    DWORD              dWord);

Arguments

pMemAllocator

This argument is deprecated in KeyView 12.10.0 and later, and should be NULL. If it is not, KeyView may use the functions in this developer-defined memory allocator to allocate memory.

pszKeyViewDir

A pointer to the directory where the Export components are located. This is normally the directory install\OS\bin, where install is the path name of the Export installation directory and OS is the name of the operating system.

pszDataFile

A pointer to the directory and file name of the Export data file, formats_e.ini. This file determines whether a format is supported. If a format does not exist in this file, the conversion fails.

The formats_e.ini file is normally stored in the directory install\OS\bin, where install is the path name of the Export installation directory and OS is the name of the operating system. See File Format Detection for more information.

pError

A pointer to an error code defined in KVErrorCode or KVErrorCodeEx in kverrorcodes.h. See KVErrorCode and KVErrorCodeEx.

dWord

Reserved. Must be 0.

Returns

Discussion