This documentation supports the 9.1 version of Remedy Action Request System.

To view the latest version, select the version from the Product version menu.

ARGetListField

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 field IDs for a particular form from the specified server. You can retrieve all fields or limit the list to fields of a particular type or fields 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 ARGetListField(
   ARControlStruct *control,
   ARNameType schema,
   unsigned long fieldType,
   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 fields for.

fieldType

A bitmask that indicates the field types to retrieve.

Bit 0:

Retrieve data fields (AR_FIELD_TYPE_DATA).

Bit 1:

Retrieve trim fields (AR_FIELD_TYPE_TRIM).

Bit 2:

Retrieve control fields (AR_FIELD_TYPE_CONTROL).

Bit 3:

Retrieve panel fields (AR_FIELD_TYPE_PAGE).

Bit 4:

Retrieve panel holder fields (AR_FIELD_TYPE_PAGE_HOLDER).

Bit 5:

Retrieve table fields (AR_FIELD_TYPE_TABLE).

Bit 6:

Retrieve column fields (AR_FIELD_TYPE_COLUMN).

Bit 8:

Retrieve vendor type fields (AR_FIELD_TYPE_VENDOR).

Bit 128:

Retrieve attachment type fields (AR_FIELD_TYPE_ATTACH).

Bit 256:

Retrieve attachment pool type fields (AR_FIELD_TYPE_ATTACH_POOL).

changedSince

A time stamp that limits the fields retrieved to those modified after the specified time. Specify 0 for this parameter to retrieve fields 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 fields that match the criteria defined by the fieldType and changedSince parameters. The system returns a list with zero items if no fields 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.

See also

ARCreateField, ARDeleteField, ARGetField, ARGetMultipleFields, ARSetField. See FreeAR for: FreeARInternalIdList, FreeARStatusList.

Was this page helpful? Yes No Submitting... Thank you

Comments