ARDBCDeleteEntry

Description

This function deletes a single entry in an external data source. The plug-in server calls this function when it receives a delete entry request from the AR System server. The AR System server sends a request when:

An AR System API program calls the ARDeleteEntry function.
Users delete entries in an external form.
The server receives a delete entry command from a workflow process to delete an entry.

Important

If you do not define this function, the AR System server receives an error message and does not delete the entry.

Synopsis

#include "ardbc.h"

int ARDBCDeleteEntry(
  void *object,
  char *tableName,
  ARVendorFieldList *vendorFieldList,
  ARInternalId transId,
  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 deletes the entry.

vendorFieldList

List of external form fields.

The plug-in uses this list to map the AR System field identification numbers (field IDs) to the 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 AR SystemDatabase Connectivity (ARDBC) plug-in. There is only one open transaction per server thread.

entryId

Unique identifier of the entry that the function must delete.

The entry ID must correspond to a value in the external data source and must be unique, non-NULL, and either a character or a numeral. For an external data source, the entry ID can have more than 15 characters. The entry ID can consist of one or more values of the type AREntryIdType and is represented by the AREntryIdList structure.

Return values

status

List of zero or more notes, warnings, or errors generated from a call made to this function.

For a description of all possible values, see Error-checking.