On-Premises Developer Guide

6.4.0
- 6.3.0
- 6.2.0
- 6.1.0
- 6.0.0

Back Next

Retrieving the State of the Engine

To retrieve the current state of the data verification engine, use an IDVE_GetJSON function call and pass the URI value in the function call as State
.

The following sample code shows an IDVE_GetJSON() call that can retrieve the engine state:

 char sJSON[ 50*1024];
         char sExtStatusMsg[ IDVE_EXT_STATUS_MSG_BUFFER_SIZE];
         IDVE_StatusCode i32StatusCode= IDVE_GetJSON("", "State", sJSON, sizeo
         f(sJSON), NULL, NULL, sExtStatusMsg);

The function call returns the current values on the properties in the

IDVEState.schema.json

file.

The elements and properties in the IDVEState.json file are organized in the following groups:

DateTime.

SystemInformation.

IDVEInformation.

Config.

Licenses.

Functions.

FileSets.

You can return the elements and properties within a single group by calling the IDVE_GetJSON function and appending the group name to the URI path. For example, to return the current Config information, call IDVE_GetJSON with the URI value State/Config.

The Config group elements and properties map to the elements and properties in the

IDVEConfig.json

file. For more information about the engine configuration properties, see the

Installation and Getting Started Guide

Verifying Addresses

Download Guide

Watch

Comments

Communities

Knowledge Base

Success Portal