ARGetListVUI

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 form views (VUI) for a particular form on the specified server. You can retrieve all views or limit the list to views modified after a specified time.

Privileges

This operation can be performed by users with access permission for the specified form.

Synopsis

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

int ARGetListVUI(
  ARControlStruct *control,
  ARNameType schema,
  ARTimestamp changedSince,
  ARPropList objPropList,
  ARInternalIdList *idList,
  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 BMC Remedy 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.

schema

The name of the form to retrieve views for.

changedSince

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

objPropList

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

Return values

idList

A list of zero or more view IDs that match the criteria defined by the changedSince parameter. The system returns a list with zero items if no views 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.