ARDeleteEntry

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 entry with the indicated ID from the specified server. You can delete entries only from base forms. To remove entries from join forms, delete them from the underlying base forms.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARDeleteEntry(
   ARControlStruct *control,
   ARNameType schema,
   AREntryIdList *entryId,
   unsigned int option,
   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 base form containing the entry to delete.

entryId

A list of values of type AREntryIdType that identify the entries. For entries of join schemas, the list contains the entry IDs for all the member forms. For other schemas, the list contains one entry ID.

option

The policy that controls the deletion of entries for join schemas.

`0:`	Delete individual entries only when the entry can be retrieved through the join schema (`AR_JOIN_DELOPTION_NONE`).
`1:`	Delete individual entries even when the entry cannot be retrieved from the join schema (`AR_JOIN_DELOPTION_FORCE`). The BMC Remedy AR System server ignores errors for entries that no longer exist.

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.