NAG Library Routine Document

x10ce_a1w_f (callback_read_integer_a1w)


x10ce_a1w_f reads an integer value from a callback data object created by x10ba_a1w_f.


Fortran Interface
Subroutine x10ce_a1w_f ( cb_handle, i, ifail)
Integer, Intent (Inout):: ifail
Integer, Intent (Out):: i
Type (c_ptr), Intent (Inout):: cb_handle
C++ Header Interface
#include <nagad.h>
extern "C" {
void  x10ce_a1w_f_ (void *&cb_handle, Integer &i, Integer &ifail)
VBA (Long integers) Header Interface
Declare PtrSafe Sub X10CEF Lib "libname" ( _
    cb_handle As LongPtr, i As Long, ifail As Long)


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. x10ce_a1w_f can be used to extract an integer value from the callback data object. In this way integer values can be communicated between a procedure argument and its companion callbacks.
Note that writing to and reading from a callback data object must be performed in strict order without omission. Reading a data item from the object is equivalent to removing that item from a data stack; reading is therefore not passive, but updates the callback data object.




1:     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, with data item removed from data stack.
2:     i – IntegerOutput
On exit: an integer value, i, to be extracted from the callback data object.
3:     ifail – IntegerInput/Output
On entry: ifail must be set to 0, -1 or 1. 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 -1 or 1 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 -1 or 1 is used it is essential to test the value of ifail on exit.
On exit: ifail=0 unless the routine detects an error or a warning has been flagged (see Section 6).

Error Indicators and Warnings

If on entry 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:
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.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.9 in How to Use the NAG Library and its Documentation for further information.
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.
Dynamic memory allocation failed.
See Section 3.7 in How to Use the NAG Library and its Documentation for further information.


Not applicable.

Parallelism and Performance

x10ce_a1w_f is not threaded in any implementation.

Further Comments



See examples for computational routines in the NAG AD Library, for example, Section 10 in c05ay_a1w_f.