ARDBCGetListSchemas

Description

This function retrieves a list of external schemas. The plug-in server calls this function when the AR System server receives an ARGetListExtSchemaCandidates request from the client to list candidate schemas.

To test your ARDBC plug-in in a vendor form, you must implement ARDBCGetListSchemas. If you do not implement this function, the Available Window Names and Available Vendor Tables 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 list schemas request, the AR System server returns a list of zero forms.

Synopsis

#include "ardbc.h"

int ARDBCGetListSchemas(
  void *object,
  ARCompoundSchemaList *schema,
  ARStatusList *status)

Input arguments

object

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

Return values

schema

List of schemas to be retrieved.

The name specified in schema-compoundSchema[n].u.vendor.vendorName must match the plug-in name specified in ARPluginIdentify in the id-name field.

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.