ARGetListImage

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 image names from the specified server. You can retrieve all images or limit the list to those images associated with particular schemas, modified after a specified time, and of a specific type.

Synopsis

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

int ARGetListImage(

ARControlStruct *control,
   ARNameList *schemaList,
   ARTimestamp changedSince,
  char *imageType,
   ARPropList objPropList,
   ARNameList *imageList,
   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 Configuration-settings-N-R.

schemaList

A list of names of forms. Only images associated with the named forms are retrieved. Specify NULL for this parameter to retrieve all images.

changedSince

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

imageType

Image type. Only images of the specified type are retrieved.

objPropList

List of server-managed object properties to search for. Returns all images that match the object properties.

Return values

imageList

A list of zero or more image names that match the criteria defined by the schemaList, changedSince, and imageType parameters. The list does not contain duplicate names or the name of images that have been deleted. The list contains zero items if no images 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.