ARDBCGetMultipleFields

Description

This function retrieves a list of fields from an external data source. The plug-in calls this function when the AR System server receives an ARGetMultipleExtFieldCandidates API function from a client. For example, a Developer Studio client might provide a user with a list of fields instead of requiring the user to enter a field name.

To test your ARDBC plug-in in a vendor form, you must implement ARDBCGetMultipleFields. If you do not implement this function, the Available Column fields in the Vendor form do not contain the name of your plug-in.

Important

If you do not define this function and the plug-in server receives a get multiple fields request, the AR System server returns a list of zero fields.

Synopsis

#include "ardbc.h"

int ARDBCGetMultipleFields(
  void *object,
  ARCompoundSchema *schema,
  ARFieldMappingList *mapping,
  ARFieldLimitList *limit,
  ARUnsignedIntList *dataType,
  ARStatusList *status)

Input arguments

object

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

schema

ARCompoundSchema structure that describes all external forms.

Return values

mapping

List of zero or more ARFieldMapping structures that describe external form fields.

limit

List of zero or more ARFieldLimit structures, each of which corresponds to the fields that the AR System server returns.

dataType

List of zero or more integers that represent the data types of the retrieved fields. See the ar.h file for the integer definitions, such as the AR_DATA_TYPE_CHAR definition.

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.