ARDBCCreateEntry

Description

This function creates an entry in the external data source. The plug-in server calls this function on request from the AR System server. The AR System server sends a request when:

An AR System API client calls the ARCreateEntry or ARMergeEntry function.
Users enter information to create or merge entries into an external form.
Users import entries into an external form.
The Distributed Server Option (DSO) transfers or merges entries into an external form.
A Push Fields filter or an escalation action creates a new entry in an external form.

Important

If you do not define this function, your plug-in does not create an entry and the AR System server receives an error message from the plug-in server.

Synopsis

#include "ardbc.h"

int ARDBCCreateEntry(
  void *object,
  char *tableName,
  ARVendorFieldList *vendorFieldList,
  ARInternalId transId,
  ARFieldValueList *fieldValueList,
  AREntryIdList *entryId,
  ARStatusList *status)

Input arguments

object

Pointer to the plug-in instance that the call to ARPluginCreateInstance returned.

tableName

Name of the external table on which the plug-in creates an entry.

vendorFieldList

List of external form fields. The plug-in uses this list to map AR System field identification numbers (field IDs) to corresponding external form field names. All other input arguments and return values must use the AR System field IDs.

transId

Transaction identification number (transaction ID) that the plug-in server designates for each transaction. The transaction ID is unique to the thread that the AR System server uses to access the ARDBC plug-in. There is only one open transaction per server thread.

fieldValueList

List of the data in a new entry. The list consists of one or more field and value pairs that the server specifies in any order.

Return values

entryId

Unique identifier for the entry that the function creates. It must correspond to a value in the external data source and must be unique, non-NULL, and either character or numeric data. For an external data source, the entry ID can have more than 15 characters. Therefore, the entry ID can consist of one or more values of type AREntryIdType and is represented by the AREntryIdList structure.

status

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.