ARWfdTerminateAPI

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

Causes workflow to return with an optionally specified error at the next opportunity. If an error is not specified, a generic TERMINATED_BY_DEBUGGER error will be returned.

Privileges

BMC Remedy AR System administrator.

Synopsis

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

int ARWfdTerminateAPI(
  ARControlStruct *control,
  unsigned int errorCode,
  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.

errorCode

The return code for the API call.

Return values

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.