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.

ARFilterApiCall

Description

The plug-in server calls this function when it receives filter API Set Fields action data or input values from the BMC Remedy AR System server during workflow operations.

To be thread-safe, your plug-in must protect any global information or resources accessed here with appropriate mutual exclusion locks. You must implement this function in all filter API plug-ins.

Synopsis


#include "arfilterapi.h"

int ARFilterApiCall(
   void *object,
   ARValueList *inValues,
   ARValueList *outValues,
   ARStatusList *status)

Input arguments

object

Pointer to the plug-in instance that the call to ARPluginCreateInstance returned.

inValues

Array of input values that the filter action specifies. BMC Remedy Developer Studio defines the filter action and what data the BMC Remedy AR System server passes to the AR filter API plug-in.

Return arguments

outValues

Array of output values that the plug-in creator defines.

status

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. The BMC Remedy AR System server passes the status results to the corresponding filter or escalation.

See also

ARPluginCreateInstance, ARPluginDeleteInstance, ARPluginIdentify, ARPluginInitialization, ARPluginTermination.

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

Comments