ARDeleteMultipleFields

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

Deletes the form fields with the indicated IDs from the specified server. Depending on the value that you specify for the deleteOption parameter, the fields are deleted from the server immediately and are not returned to users who request information about fields. This function performs the same action as ARDeleteField but is easier to use and more efficient than deleting multiple entries one by one.

Synopsis

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

int ARDeleteMultipleFields(
  ARControlStruct *control,
  ARNameType schema,
  ARInternalIdList *fieldList,
  unsigned int deleteOption,
  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.

If a valid overlay group is specified in the control record, the ARDelete* function operates on the object that belongs to that group. If no group is specified, the function operates on the origin object. To specify whether to use an object's real or resolved name in an operation and whether to perform the operation only on objects in a specified overlay group, use the AR_SESS_CONTROL_PROP_DESIGN_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARGetSessionConfiguration).

schema

The name of the form containing the fields to be deleted.

fieldList

The internal IDs of the fields to be deleted.

deleteOption

A value that indicates the action to be taken if one of the specified fields contain data (only applicable to base forms) or are associated with a join form.

Return values

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.