ARGetMultipleExtFieldCandidates

Note

You can continue to use C APIs to customize your application, but C APIs are not enhanced to support new capabilities provided by Java APIs and REST APIs.

Description

Retrieves a list of all available external data source fields (field candidates). Users choose the data from one of these field candidates to populate the vendor form.

Privileges

The system returns information based on the access privileges of the user that you specify for the control parameter. All lists, therefore, are limited to fields the user can access.

Synopsis

#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"

int ARGetMultipleExtFieldCandidates(
  ARControlStruct *control,
  ARCompoundSchema *schema,
  ARFieldMappingList *fieldMapping,
  ARFieldLimitList *limit,
  ARUnsignedIntList *dataType,
  ARStatusList *status)

Input arguments

control

The control record for the operation. It contains information about the user requesting the operation, where that operation is to be performed, and which session is used to perform it. The user and server fields are required.

schema

The definition of the candidate form or table that contains the candidate field to retrieve.

Return values

fieldMapping

A list of candidate field definitions.

limit

A list of field limits for the candidate fields.

datatype

A list of field datatypes for the candidate fields.

status

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