fpGetLicenseInfoAsJSON()
Returns information about your File Content Extraction license, in JSON format.
This function can be used to determine whether a license key is valid or has expired.
Syntax
KVErrorCode(pascal* fpGetLicenseInfoAsJSON)(
const char* const szLicense,
char** const pszLicenseInfo);
Arguments
szLicense
|
A string that contains your license key. |
pszLicenseInfo
|
A pointer to a string. On success, this will point to a string containing the license information in JSON format. |
Returns
The return value is an error code.
- If the call is successful, the return value is
KVError_Successand the license information is stored in the specified string. - If the call is unsuccessful, the return value is an error code that indicates the problem.
Lifetimes and Memory Management
To free the memory allocated by this function, use fpFreeString().
Discussion
A JSON schema for the license information is included in the schemas folder of the SDK. OpenText recommends that you consult the schema for information about the fields.
The following is an example response for a valid license that expires on 01 May 2026 (292 days in the future when the function was called).
{
"Status": "Valid",
"ExpiryDate": "2026-05-01T00:00:00Z",
"ExpiryDays": "292",
"ExpiryEpochSeconds": 1777593600
}
Example
The following example obtains information about a license key and prints it to the console.
#include <stdio.h>
#include "kvfilt.h"
void main()
{
KVFltInterfaceEx filter;
KVErrorCode error = KV_GetFilterInterfaceEx(&filter, KVFLTINTERFACE_REVISION);
if(error == KVError_Success)
{
const char* myLicenseKey = "YOUR_LICENSE_HERE";
char* myLicenseInfo = NULL;
error = filter.fpGetLicenseInfoAsJSON(myLicenseKey, &myLicenseInfo);
if(error == KVError_Success)
{
printf("%s\n", myLicenseInfo);
filter.fpFreeString(&myLicenseInfo);
}
}
}