Installation and Getting Started Guide

Installation and Getting Started Guide

Retrieving the Software Version Number

Retrieving the Software Version Number

To fetch the version number of the software, use the IDVE_GetVersion() function. The Address Verification version number count begins with 6 and the IDVE version number count begins with 1 at launch as IDVE is a new module of the software. You can call the IDVE_GetVersion() function at any time.
You can retrieve the following version numbers:
  • The version of the IDVE framework. When you provide an empty string URI (""), the IDVE_GetVersion() function fetches the IDVE framework version number, for example "0.0.2.51140".
  • The version of the Address Verification function. When you provide an URI to the function ("AV"), the IDVE_GetVersion() function fetches the Address Verification version number, for example "6.0.0.51140".
You can retrieve the version number without initializing IDVE.
The following sample code shows the structure of the IDVE_GetVersion() function:
IDVE_EXPORTCALL1 IDVE_StatusCode IDVE_EXPORTCALL2 IDVE_GetVersion( const char* const kpksURI, char* const kpsValueBuffer, const IDVE_U64 ku64ValueBufferSize, IDVE_U64* const kpu64SizeWritten, char* const kpsExtStatusMsg );
The following table shows the function definitions of the IDVE_GetVersion() function:
Function
Operation
Comment
const char* const kpksURI
[in]
Pointer to the zero-terminated 7-bit ASCII URI with desired version, for example "" for IDVE or "AV" for AddressVerification. The value might not be NULL.
char* const kpsValueBuffer,
[out]
Pointer to the output buffer that receives the UTF-8 encoded version string and the terminating zero. The value might not be NULL.
const IDVE_U64 ku64ValueBufferSize
[in]
Size of the output buffer in code units, including the terminating zero.
IDVE_U64* const kpu64SizeWritten
[out]
Pointer to an unsigned 64-bit integer value that receives the size of the output written in code units, excluding the terminating zero. The value might be NULL.
char* const kpsExtStatusMsg
[out]
Pointer to a buffer of size IDVE_EXT_STATUS_MSG_BUFFER_SIZE for an optional extended status message. The value might be NULL.

0 COMMENTS

We’d like to hear from you!