AREndBulkEntryTransaction

Important

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Marks the ending of a series of entry API function calls that are grouped together and sent to the AR System server as part of one transaction. All calls related to create, set, delete, and merge operations made before the call to this function and after the preceding ARBeginBulkEntryTransaction call is sent to the server when this function is called and executed within a single database transaction.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"

int AREndBulkEntryTransaction(
  ARControlStruct *control,
  unsigned int actionType,
  ARBulkEntryReturnList *bulkEntryReturnList,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

actionType

The action to be taken. Use AR_BULK_ENTRY_ACTION_SEND to transmit the queued entry calls to the server and end the transaction. Use AR_BULK_ENTRY_ACTION_CANCEL to remove the queued entry calls and end the transaction.

Return values

bulkEntryReturnList

A list of return structures corresponding to the individual operations executed within the bulk entry transaction. This parameter can be NULL. If it is not NULL, this parameter returns information regardless of whether the status parameter indicates an error occurred.
The status of the individual calls is returned in the order the calls were issued, up to and including the last call executed on the server. If any of the individual calls fail, the list terminates with the return structure for the failed call. Any return information from previous calls that were successful can be ignored.

status

A list of zero or more notes, warnings, or errors generated from a call to this function. For a description of all possible values, see Error-checking.
If any of the individual entry calls fail during the execution of the API call, the error code 9713 (AR_ERROR_BULK_ENTRY_CALL_FAILED) is returned and the transaction is rolled back. The status of each individual entry call is returned in the bulkEntryReturnList.