Error: Invalid spaceKey on retrieving a related space config.

ARGetFilter

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 information about the specified filter from the specified server.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARGetFilter(
   ARControlStruct *control,
   ARNameType name,
   unsigned int *order,
   ARWorkflowConnectStruct *schemaList,
   unsigned int *opSet,
   unsigned int *enable,
   ARQualifierStruct *query,
   ARFilterActionList *actionList,
   ARFilterActionList *elseList,
   char **helpText,
   ARTimestamp *timestamp,
   ARAccessNameType owner,
   ARAccessNameType lastChanged,
   char **changeDiary,
   ARPropList *objPropList,
   unsigned int *errorFilterOptions
   ARNameType errorFilterName
   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.

name

The name of the filter to retrieve.

Return values

order

A value between 0 and 1000 (inclusive) that determines the filter execution order. When multiple filters are associated with a form, the value associated with each filter determines the order in which they are processed (from lowest to highest). Specify NULL for this parameter if you do not want to retrieve this value.

schemaList

The list of form names the filter is linked to. The filter must be associated with a single form or a list of forms that currently exists on the server. Specify NULL for this parameter if you do not want to retrieve the list.

opSet

A bitmask that indicates the form operations that trigger the filter. See ARCreateFilter for a description of the possible values. Specify NULL for this parameter if you do not want to retrieve the operation set.

enable

A flag that specifies whether the filter is disabled (0) or enabled (1). Specify NULL for this parameter if you do not want to retrieve this flag.

query

A qualification that determines whether the filter is executed. The system returns 0 (AR_COND_OP_NONE) if the filter has no qualification. Specify NULL for this parameter if you do not want to retrieve the query.

actionList

The set of actions performed if the condition defined by the query parameter is satisfied. This list can contain from 1 to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve the action list.

elseList

The set of actions performed if the condition defined by the query parameter is not satisfied. This list can contain from 0 to 25 actions (limited by AR_MAX_ACTIONS). Specify NULL for this parameter if you do not want to retrieve the else list.

helpText

The help text associated with the filter. Specify NULL for this parameter if you do not want to retrieve the help text. This value can be large, so do not retrieve it if the program does not need it, for example, if the program is only checking it an object exists.

timestamp

A time stamp that specifies the last change to the filter. Specify NULL for this parameter if you do not want to retrieve this value.

owner

The owning user for the filter. Specify NULL for this parameter if you do not want to retrieve this value.

lastChanged

The user who made the last change to the filter. Specify NULL for this parameter if you do not want to retrieve this value.

changeDiary

The change diary associated with the filter. The server adds the user making the change and a time stamp when it saves the change diary. Use ARDecodeDiary to parse the change diary into user, time stamp, and text components. Specify NULL for this parameter if you do not want to retrieve the change diary. This value can be large, so do not retrieve it if the program does not need it, for example, if the program is only checking it an object exists.

objPropList

A list of server object properties. If this parameter is set to NULL, no properties list is returned. See Server object properties.

errorFilterOptions

The error handler options for the filter. Returns AR_FILTER_ERRHANDLER_ENABLE if an error handler filter is enabled, zero if not. Specify NULL for this parameter if you do not want to retrieve this value.

errorFilterName

The name of error handler filter for this filter; NULL if none. Specify NULL for this parameter if you do not want to retrieve this value.

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

ARCreateFilter, ARDecodeDiary, ARDeleteFilter, ARGetListFilter, ARGetMultipleFilters, ARSetFilter. See FreeAR for: FreeARFilterActionList, FreeARPropList, FreeARQualifierStruct, FreeARStatusList.

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

Comments