ARDeleteField

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

Deletes the form field with the indicated ID from the specified server. Depending on the value that you specify for the deleteOption parameter, the field is deleted from the server immediately and is not returned to users who request information about fields.

When a parent field is deleted, its child fields might also be deleted. For example, deleting a panel holder field deletes all panels within it. All fields within those panels are removed from the current view but not deleted. Deleting a table field deletes all columns within it.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARDeleteField(
  ARControlStruct *control,
  ARNameType schema,
  ARInternalId fieldId,
  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 field to delete.

fieldId

The internal ID of the field to delete.

deleteOption

A value that indicates the action to take if the specified field contains data (applicable only to base forms) or is associated with a join form.The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.

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.