Hot-Swapping Reference Data for Address Verification (On-Premises)

Back Next

Hot-Swap by API

Use the API method for hot-swap integration into a host application.

The Address Verification C API offers the following function to trigger a hot swap:

/// Trigger a file set hot swap
IDVE_EXPORTCALL1 IDVE_StatusCode IDVE_EXPORTCALL2 IDVE_SwapFileSet (
	const IDVE_Bool kbFileSetA , ///< [in] A
bool value, if != 0 then file set A is ready to use, if 0 then file
set B is ready to use
	const IDVE_Bool kbWait , ///< [in] A bool value, if != 0
then the function waits for completion of the hot swap operation,
if 0 then it returns immediatly
	char * const kpsExtStatusMsg ///< [out] Pointer to buffer of size
IDVE_EXT_STATUS_MSG_BUFFER_SIZE for an optional extended status
msg, may be NULL
);

The first argument

kbFileSetA

is a flag that identifies the file set to declare as ready to use. A value of

IDVE_TRUE

corresponds to FileSetA while

IDVE_FALSE

corresponds to FileSetB. The call fails if you trigger a hot swap to activate a file set that is already in use.

The second argument

kbWait

determines if the verification engine will block a call to the engine and wait for the completion of a hot swap. A value of

IDVE_TRUE

will cause the call to wait until the hot swap has been performed and all new data files are available. A value of

IDVE_FALSE

will perform the hot swap in a background thread while the calling thread returns immediately.

The third argument

kpsExtStatusMsg

enables an extended status message in the same manner as other C API calls.

When you call

IDVE_SwapFileSet

synchronously, the status code and status message will contain any error that occurred during the attempt to swap. When you perform an asynchronous call, error information will only appear in Address Verification's initialization log.

Rename Saved Search

Table of Contents

Hot-Swapping Reference Data for Address Verification (On-Premises)

Hot-Swapping Reference Data for Address Verification (On-Premises)

Hot-Swap by API

Hot-Swap by API