ARLoadARQualifierStruct

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

Loads the specified qualification string (if valid for the form) into an ARQualifierStruct structure. This function simplifies the process of specifying qualifications in the required format.

Synopsis

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

int ARLoadARQualifierStruct(
  ARControlStruct *control,
  ARNameType schema,
  ARNameType displayTag,
  char *qualString,
  ARQualifierStruct *qualifier,
  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 name of the form to which the qualification applies.

displayTag

The name of the form view (VUI) to use for resolving field names. If the specified view does not exist or does not contain a field specified in the qualification string (or you specify NULL for this parameter), the system uses the field label or field ID in the default view. If the field is not available on the view, field label is used. If the view name is not provided, the default view is used.

qualString

A character string containing the qualification to load (following the syntax rules for entering qualifications in ).

Return values

qualifier

An ARQualifierStruct structure that contains the specified qualification. Use FreeARQualifierStruct to recursively free the allocated memory associated with this structure as soon as you no longer need it.

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.