ARDBCGetEntry

Synopsis

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 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

The unique identifier for the entry that this function must retrieve.

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 type AREntryIdType and is represented by the AREntryIdList structure.

idList

List of zero or more AR System field identification numbers (field IDs) of the fields that the function must 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 AR System server specifies in a random order.

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.