ARGetListEntryBlocks

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

Retrieves a list of blocks of entries from the specified server. Data is returned as a data structure, AREntryListBlock. Entries are encapsulated in the AREntryListBlock data structure and divided into blocks of entries. Your program calls ARGetEntryBlock with a block number to return a list of entries for that block.

Privileges

The system returns information based on the access privileges of the user that you specify for the control parameter. All lists, therefore, are limited to entries the user can access (users must have permission for the entryId field to access and retrieve entries).

Synopsis

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

int ARGetListEntryBlock(
   ARControlStruct *control,
   ARNameType schema,
   ARQualifierStruct *qualifier,
   AREntryListFieldList *getListFields,
   ARSortList *sortList,
   unsigned int numRowsPerBlock,
   unsigned int firstRetrieve,
   unsigned int maxRetrieve,
   ARBoolean useLocale,
   AREntryBlockList *entryBlockList,
   unsigned int *numReturnedRows,
   unsigned int *numMatches,
   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 to retrieve entries for.

qualifier

A query that determines the set of entries to retrieve. The qualification can include one or more fields and any combination of conditional, relational, and arithmetic (numeric data types only) operations. The system generates an error if the user does not have read permission for a field or a field does not exist. Specify NULL or assign an operation value of 0 (AR_COND_OP_NONE) to match all form entries.

getListFields

A list of zero or more fields to be retrieved with each entry. The list can include any data fields except diary fields and long character fields. The system checks the permissions for each specified field and returns only those fields for which you have read access.

sortList

A list of zero or more fields that identifies the entry sort order. The system generates an error if you do not have read access on all specified fields. Specify NULL for this parameter (or zero fields) to use the default sort order for the form. The system sorts the entries in ascending order by entryId if the form has no default sort order.

numRowsPerBlock

The number of rows per block of data retrieved.

firstRetrieve

The first entry to retrieve. A value of 0 (AR_START_WITH_FIRST_ENTRY) represents the first entry. A value of 1 will skip the first entry.

maxRetrieve

The maximum number of entries to retrieve. Use this parameter to limit the amount of data returned if the qualification does not sufficiently narrow the list. Specify 0 (AR_NO_MAX_LIST_RETRIEVE) to assign no maximum.

useLocale

A flag that indicates whether to search for entries based on the locale. If you specify 1 (TRUE) and the Localize Server option is selected, entries are searched using the locale specified in AR_RESERV_LOCALE_LOCALIZED_SCHEMA. If no matches are found for the specified locale, the search becomes less restrictive until a match is found. If you specify 0 (FALSE) or the Localize Server option is cleared, all entries are searched. For more information, see Setting the Localize Server option.

Return values

entryBlockList

A list of zero or more (accessible) entries that match the criteria defined by the qualifier parameter. The system returns a list with zero items if no entries match the specified criteria.

numReturnedRows

The total number of returned rows in the block.

numMatches

The total number of (accessible) entries that match the qualification criteria. This value does not represent the number of entries returned unless the number of matching entries is less than or equal to the maxRetrieve value. Specify NULL for this parameter if you do not want to retrieve this value.