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

Deleting a Job Object

Deleting a Job Object

When you no longer need a job object, delete the job with the IDVE_Delete() function. Pass the URI that the engine returned with the IDVE_Post() function when you created the job object.
The following sample code shows the structure of the IDVE_Delete() function:
IDVE_EXPORTCALL1 IDVE_StatusCode IDVE_EXPORTCALL2 IDVE_Delete( const char* const kpksCustomerID, const char* const kpksURI, char* const kpsExtStatusMsg );
The following table shows the parameter definitions of the IDVE_Delete() 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/IO
". The value might not 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 can be NULL.