ARGetMultipleEntries

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

Retrieves the group of form entries specified by the entryIdList parameter. You can retrieve data for specific fields or all (accessible) fields. This function returns only the name, size, and compressed size of attachment fields. Use ARGetEntryBLOB to retrieve the contents of the attachment. This function performs the same action as ARGetEntry but is easier to use and more efficient than retrieving multiple entries one by one.

Important

A maximum of 100 entries can be returned by this function. If you need to return more than 100 entries, call this function multiple times.

Privileges

The system returns data based on the access privileges of the user that you specify for the control parameter. User permissions are verified for each specified entry and field. The system returns values for accessible fields and warning messages for fields that the user cannot access.

Synopsis

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

int ARGetMultipleEntries(
  ARControlStruct *control,
  ARNameType schema,
  AREntryIdListList *entryIdList,
  ARInternalIdList *IdList,
  ARBooleanList *existList,
  ARFieldValueListList *fieldList,
  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 containing the entries to be retrieved.

entryIdList

The list of zero or more entries to retrieve.

IdList

A list of zero or more internal IDs that specify the fields to be retrieved.

Specify NULL for this parameter (or zero fields) to retrieve all (accessible) fields. To improve performance, specify only the fields that you need.

If you specify an attachment field in the list, only its name, size, and compressed size are returned. Use ARGetEntryBLOB to retrieve the contents of the attachment.

Return values

existList

A list of flags and corresponding Boolean values that indicate whether the entries exist. The value TRUE means the entry exists and FALSE means the entry does not exist.

fieldList

A list of zero or more fields and associated values that identify the data for the specified entries. The fields are returned in the order specified by fieldIdList. If a specified entry does not exist, the system returns zero (or NULL ) for that entry. If the user does not have permission for a specified field or the field does not exist, the system returns NULL for the associated value within each entry value list.

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.