ARDBCGetEntry

Description

This function retrieves a single entry from an external data source table. The plug-in server calls this function when the receives an ARGetEntry request from a client.

Synopsis

#include "ardbc.h"

int ARDBCGetEntry(
  void *object,
  char *tableName,
  ARVendorFieldList *vendorFieldList,
  ARInternalId transId,
  AREntryIdList *entryId,
  ARInternalIdList *idList,
  ARFieldValueList *fieldList,
  ARStatusList *status)

Input arguments

object

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

tableName

Name of the external table from which the plug-in retrieves this entry.

vendorFieldList

List of external form fields. The plug-in uses this list to map field identification numbers (field IDs) to corresponding external form field names. All other input arguments and return values must see the 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 uses to access the ARDBC plug-in. There is only one open transaction per server thread.

entryId

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

idList

List of zero or more field identification numbers (field IDs) for the fields to retrieve. If the idList value is NULL or the list contains zero field IDs, the function retrieves all the fields.

Return values

fieldList

List of the data in the entry that this function retrieves. The list consists of one or more field and value pairs that the specifies in any order.

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.