# NAG Library Routine Document

## 1Purpose

x10bj_a1w_f writes an object of the type nagad_a1w_w_rtype into a callback data object created by x10ba_a1w_f.

## 2Specification

Fortran Interface
 Subroutine x10bj_a1w_f ( xa,
 Integer, Intent (Inout) :: ifail Type (c_ptr), Intent (Inout) :: cb_handle Type (nagad_a1w_w_rtype), Intent (In) :: xa
extern "C" {
 void x10bj_a1w_f_ (void *&cb_handle, const nagad_a1w_w_rtype &xa, Integer &ifail)
}
 Declare PtrSafe Sub X10BJF Lib "libname" ( _ cb_handle As LongPtr, xa As nagad_a1w_w_rtype, ifail As Long)

## 3Description

For routines where it is necessary to perform callback operations via one or more companion callbacks, data must be passed between the procedure argument and any such companion callback via a callback data object as created by x10ba_a1w_f. x10bj_a1w_f can be used to insert an object of the type nagad_a1w_w_rtype into the callback data object. In this way an object of the type nagad_a1w_w_rtype can be communicated between a procedure argument and its companion callbacks.
Note that data must be written to and read from the callback data object in strict order without omission.

None.

## 5Arguments

1:     $\mathbf{cb_handle}$ – Type (c_ptr)Input/Output
On entry: will contain a handle to the callback data object.
On exit: will contain a handle to the updated callback data object.
2:     $\mathbf{xa}$ – Type (nagad_a1w_w_rtype)Input
On entry: an object of the type nagad_a1w_w_rtype, ${x}_{a}$, to be inserted into the callback data object.
3:     $\mathbf{ifail}$ – IntegerInput/Output
On entry: ifail must be set to $0$, . If you are unfamiliar with this argument you should refer to Section 3.4 in How to Use the NAG Library and its Documentation for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value  is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this argument, the recommended value is $0$. When the value  is used it is essential to test the value of ifail on exit.
On exit: ${\mathbf{ifail}}={\mathbf{0}}$ unless the routine detects an error or a warning has been flagged (see Section 6).

## 6Error Indicators and Warnings

If on entry ${\mathbf{ifail}}=0$ or $-1$, explanatory error messages are output on the current error message unit (as defined by x04aaf).
Errors or warnings detected by the routine:
${\mathbf{ifail}}=1$
On entry, cb_handle does not define a valid handle to a NAG AD callback data object. It has not been initialized or has been corrupted.
${\mathbf{ifail}}=-99$
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-399$
Your licence key may have expired or may not have been installed correctly.
See Section 3.8 in How to Use the NAG Library and its Documentation for further information.
${\mathbf{ifail}}=-999$
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.

Not applicable.

## 8Parallelism and Performance

x10bj_a1w_f is not threaded in any implementation.