Table of Contents

Search

  1. Preface
  2. Part 1: On-Prem Operations
  3. Part 2: Parameter and Element Reference
  4. Appendix A: JSON Schema
  5. Appendix B: Geocode Countries
  6. Appendix C: Certified Mode Values

Developer Guide

Developer Guide

Boolean and Integer Values

Boolean and Integer Values

To retrieve individual integer or boolean values, for example ResultQuality values, use the IDVE_GetInt32(), IDVE_GetInt64(), or IDVE_GetBool() function instead of IDVE_GetString().
The following sample code shows the structure of the IDVE_GetBool() function:
IDVE_EXPORTCALL1 IDVE_StatusCode IDVE_EXPORTCALL2
IDVE_GetBool
( const char* const kpksCustomerID, const char* const kpksURI,
IDVE_Bool* const kbValue
, IDVE_Bool* const kpbIsValuePresent, char* const kpsExtStatusMsg );
To use the IDVE_GetInt32() or IDVE_GetInt64() function, replace IDVE_GetBool with IDVE_GetInt32 or IDVE_GetInt64 in the structure. Also, change the parameter name
IDVE_Bool* const kbValue
to
IDVE_I32* const kpi32Value
or
IDVE_I64* const kpi64Value
to point to 32-bit or 64-bit integer values respectively.
The following table shows the parameter definitions for the IDVE_GetBool() function:
Parameter
Operation
Comment
const char* const kpksCustomerID
[in]
Pointer to the zero-terminated 7-bit ASCII-encoded customer ID. The value might not be NULL.
const char* const kpksURI
[in]
Pointer to the zero-terminated 7-bit ASCII URI, for example "
AV/v1/Jobs/0/Parameters/CountrySets/0/OutputDetail/ElementStatus
". The value might not be NULL.
IDVE_Bool* const kbValue
[out]
Pointer to a boolean value that the user provides. The boolean receives a copy of the boolean value present at the given URI. The pointer must not be NULL.
IDVE_Bool* const kpbIsValuePresent
[out]
Pointer to the boolean value to be retrieved by the function call. If you provide a valid pointer for kpbIsValuePresent, the function will indicate if the value at the given URI is present by setting kpbIsValuePresent to true or false.
If you provide NULL for kpbIsValuePresent and the boolean value that you want to retrieve does not exist, the function call will report an error. If you provide NULL for kpbIsValuePresent and the boolean value exists, it is retrieved normally.
char* const kpsExtStatusMsg
[out]
Pointer to a buffer of size IDVE_EXT_STATUS_MSG_BUFFER_SIZE for an optional extended status message. The value can be NULL.


Updated July 30, 2020