On-Premises Developer Guide

6.5.0
- 6.4.0
- 6.3.0
- 6.2.0
- 6.1.0
- 6.0.0

Back Next

Retrieving Optional Properties

The IDVE_IsValuePresent() function identifies any optional JSON property that has no default value in a JSON schema document. For example, if you want to know if the error log has been disabled because of an error, you can call IDVE_IsValuePresent() on the URI "

State/IDVEInformation/ErrorLog/ErrorCode

". You can use this function call to check for the presence of optional properties in a JSON document.

If you call the IDVE_IsValuePresent() function on a non-optional property, the function returns true
as output.

Example: The IDVE_IsValuePresent() function

The following sample code shows the structure of the IDVE_IsValuePresent() function:

IDVE_EXPORTCALL1 IDVE_StatusCode IDVE_EXPORTCALL2 IDVE_IsValuePresent(
   const char* const kpksCustomerID,
   const char* const kpksURI,
   IDVE_Bool* const kbValue,
   char* const kpsExtStatusMsg
);

The following table shows the parameter definitions for the IDVE_IsValuePresent() 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/###/IO/Outputs/0/Results/0/Variants/0/AddressElements/AdministrativeDivision ". The value might not be NULL.
IDVE_Bool* const kbValue	[out]	Pointer to a boolean value to be retrieved by the function call. If the pointer is not NULL, it indicates if the value at the given URI is present or not.
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.

Rename Saved Search

Table of Contents

On-Premises Developer Guide

On-Premises Developer Guide

Retrieving Optional Properties

Retrieving Optional Properties

Example: The IDVE_IsValuePresent() function