Library management functions


Functions

AFP_RETCODE AFP_Init (void *pReserved, AFP_ErrorInfo *pErrorInfo)
 Initializes the SDK.
AFP_RETCODE AFP_Shutdown (AFP_ErrorInfo *pErrorInfo)
 Cleans up and shuts down the SDK.
AFP_RETCODE AFP_GetConfigOption (AFP_CONFIGOPTION configOption, void **ppOptionVal, AFP_ErrorInfo *pErrorInfo)
 Retrieves a library configuration option.
const char * AFP_GetBuildDate ()
 Returns the date/time the SDK was built.

Function Documentation

AFP_RETCODE AFP_Init void *  pReserved,
AFP_ErrorInfo pErrorInfo
 

Initializes the SDK.

This function must be called exactly once before using any of the other SDK functions.

Parameters:
pReserved Must be NULL.
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The SDK was initialized successfully.
See also:
AFP_Shutdown()

AFP_RETCODE AFP_Shutdown AFP_ErrorInfo pErrorInfo  ) 
 

Cleans up and shuts down the SDK.

This function must be called exactly once after using the SDK.

Parameters:
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The SDK was shut down successfully.
See also:
AFP_Init()

AFP_RETCODE AFP_GetConfigOption AFP_CONFIGOPTION  configOption,
void **  ppOptionVal,
AFP_ErrorInfo pErrorInfo
 

Retrieves a library configuration option.

Parameters:
configOption Config option to retrieve.
ppOptionVal Will be filled in with a pointer to the option value. Refer to the documentation for each config option for details about what will be returned here.
pErrorInfo Returns error information (optional).
Return values:
AFPRC_OK The config option was successfully retrieved.