ARWfdGetCurrentLocation

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

Requests the current location of the worker thread during debugging.

Privileges

AR System administrator.

Synopsis

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

int ARWfdGetCurrentLocation(
  ARControlStruct *control,
  unsigned int howFarBack,
  ARWfdCurrentLocation *location,
  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.

howFarBack

Stack location of a filter. A value of 0 requests information about the filter that is currently executing. Higher values request information about other positions on the call stack.

Return values

location

A current location structure. If the value of howFarBack exceeds the number of stack frames, the value of location will be NULL.

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.