fpInitWithLicenseData()
This function initializes an Export session with license information passed in function parameters rather than a license file. If initialization is successful, it sets the KVPDFContext
value pointed to by pContext
to a valid context identifier. You must pass this context value as the first parameter to all other PDF Export functions.
This function is similar to fpInit(), but it uses a different licensing method. You can use either fpInit() or fpInitWithLicenseData
to initialize your Export session. However, these functions are mutually exclusive. That is, neither takes the context pointer from the other as an argument. If you call both functions, you initialize two distinct Export sessions, in the same way as calling fpInit() twice.
Syntax
KVPDFState pascal fpInitWithLicenseData( const char* const pszKeyViewDir, const char* const pszTempFolder, const char* const pszLicenseOrganization, const char* const pszLicenseKey, /*out*/ KVPDFContext* const pContext);
Arguments
|
A null-terminated C string that contains the path of the directory where the Export components are located. This is normally the directory |
|
A pointer to a string that contains the organization name under which this installation of KeyView is licensed. This value is the company name that appears at the top of the license key provided by Micro Focus. Add the text exactly as it appears in this file. |
|
A pointer to a string that contains the license key for this installation of KeyView. This value is the appropriate license key provided by Micro Focus. The key is a string that contains 31 characters, for example |
|
(Optional) A null-terminated C string that contains the path of a directory to use to store temporary files during the conversion process. Set this value to NULL to default to the system temporary directory. |
|
A valid pointer to a value of type KVPDFContext . If initialization is successful, this target is set to a context-identifying value, which you must supply to subsequent export functions. |
Returns
If the call is successful, a KVPDFState
structure with eErrorCode
set to KVERR_Success
.
If the call is unsuccessful, a KVPDFState
structure that indicates the reason for the error.
Discussion
-
You can perform multiple calls to subsequent functions in serial using the same context (session).
-
On Windows systems, specify the paths in the local Windows code page.
-
To ensure multithreaded conversions are thread-safe, you must create a unique context pointer for every thread by calling fpInit(). In addition, threads must not share context pointers, and you must use the same context pointer for all API calls in the same thread.
-
When the conversion context is no longer required, you must terminate by calling fpShutDown(). See fpShutDown().
-
Internally,
KVPDFContext
is a pointer, and Micro Focus recommends that you initialize values of typeKVPDFContext
to NULL. -
If the call is unsuccessful, the value pointed to by
pContext
is not modified. No context has been created so there is no need to call fpShutDown().IMPORTANT: It is not safe to call fpShutDown() with any value other than one arising from a successful call to fpInit() (or NULL).
-
On Windows,
pszKeyViewDir
andpszTempFolder
must be in the local Windows code page.