ARGetListExtSchemaCandidates

Important

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 tables (schema candidates). Users select fields from these candidates to populate the vendor form.

Synopsis

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

int ARGetListExtSchemaCandidates(
  ARControlStruct *control,
  unsigned int schemaType,
  ARCompoundSchemaList *schemaList,
  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.

schemaType

A value that indicates the form types to retrieve.

To retrieve both visible and hidden forms, add 1024 (AR_HIDDEN_INCREMENT) to the form type. For example: Specify AR_SCHEMA_VENDOR | AR_HIDDEN_INCREMENT for this parameter.

Return values

schemaList

A list of zero or more (accessible) forms that match the criteria in the schemaType parameter. Specify NULL for this parameter if you do not want to retrieve the list.

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.