ARCreateEntry
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
Creates a new entry in the indicated schema (form) on the specified server. You can only create entries in base schemas. To add entries to join forms, create them in one of the underlying base forms.
Privileges
The system creates data based on the access privileges of the user that you specify for the control
parameter and the createMode setting for each field (see ARCreateField). User permissions are verified for each specified field. The system generates an error if the user does not have write permission for a field or a field does not exist.
Synopsis
#include "ar.h"
#include "arerrno.h"
#include "arextern.h"
#include "arstruct.h"
int ARCreateEntry(
ARControlStruct *control,
ARNameType schema,
ARFieldValueList *fieldList,
AREntryIdType *entryId,
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 schema to create the entry in.
fieldList
A list of one or more field/value pairs (specified in any order) that identifies the data for the new entry. You must specify values for all required fields that do not have defined defaults. Values must be of the data type defined for the field or have a data type of 0
(AR_DATA_TYPE_NULL
). NULL
values can only be specified for optional fields, and assigning NULL
overrides any defined field default. An error is generated if a field does not exist or the user specified by the control
parameter does not have write permission for a field.
Return values
entryId
The unique identifier for the new entry (system-generated).
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.
See also
ARDeleteEntry, ARGetEntry, ARGetListEntry, ARMergeEntry, ARSetEntry. See FreeAR for: FreeARFieldValueList, FreeARStatusList.
Comments
Log in or register to comment.