ARGetListContainer

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 a list of containers from the specified server. You can retrieve all (accessible) containers or limit the list to containers of a particular type, containers owned by a specified form, or containers modified after a specified time.

Synopsis

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

int ARGetListContainer(
  ARControlStruct *control,
  ARTimestamp changedSince,
  ARContainerTypeList *containerTypes,
  unsigned int attributes,
  ARContainerOwnerObjList *ownerObjList,
  ARPropList *objPropList,
  ARContainerInfoList *conList,
  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.

To specify whether to search for an object's real or resolved name, use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable of the ARSetSessionConfiguration function (see ARSetSessionConfiguration). For calls that use field or view IDs, the search is performed on the real or resolved name of the associated form.

If you do not use the AR_SESS_CONTROL_PROP_API_OVERLAYGROUP variable, the AR System server uses the default overlay group at run time. For information about configuring the default overlay group, see the description for Overlay-mode in ar-cfg-or-ar-conf-options-N-R.

changedSince

A time stamp that limits the containers retrieved to those modified after the specified time. Specify 0 for this parameter to retrieve containers with any modification time stamp.

containerTypes

A list of values that indicates the container types to be retrieved.

attributes

Specify AR_HIDDEN_INCREMENT for this parameter to retrieve both visible and hidden containers. Specify NULL for this parameter to retrieve only visible containers.

ownerObjList

A list of the structures that limit the containers retrieved, based on the object that owns them. Specify NULL for this parameter to reference all containers.

objPropList

List of server-managed object properties to search for. Returns all containers that match the object properties; for example, the application owner. See Server-managed object property tags.

Return values

conList

A list of zero or more (accessible) containers that match the criteria defined by the containerTypes, ownerObj, changedSince, and objPropList parameters. The system returns a list with zero items if no containers match the specified criteria.

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.