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.

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 this 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 see 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.

entryId

Unique identifier for the entry that to delete. 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.

Return values

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.

See also

ARDBCCreateEntry, ARDBCGetEntry, ARDBCGetEntryBLOB, ARDBCSetEntry.