NAG FL Interface
g22zaf (handle_​free)

Note: please be advised that this routine is classed as ‘experimental’ and its interface may be developed further in the future. Please see Section 4 in How to Use the NAG Library for further information.
Settings help

FL Name Style:

FL Specification Language:

1 Purpose

g22zaf destroys a G22 handle and deallocates all the memory used.

2 Specification

Fortran Interface
Subroutine g22zaf ( handle, ifail)
Integer, Intent (Inout) :: ifail
Type (c_ptr), Intent (Inout) :: handle
C Header Interface
#include <nag.h>
void  g22zaf_ (void **handle, Integer *ifail)
The routine may be called by the names g22zaf or nagf_blgm_handle_free.

3 Description

Each G22 handle should be deallocated to avoid memory leaks. Therefore, g22zaf should be called on all such handles which are no longer needed. Please note that passing an uninitialized handle might cause unpredictable behaviour, including a crash of your program.

4 References


5 Arguments

1: handle Type (c_ptr) Input/Output
On entry: the G22 handle to be destroyed.
On exit: the handle is destroyed and set to c_null_ptr.
2: ifail Integer Input/Output
On entry: ifail must be set to 0, −1 or 1 to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of 0 causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of −1 means that an error message is printed while a value of 1 means that it is not.
If halting is not appropriate, the value −1 or 1 is recommended. If message printing is undesirable, then the value 1 is recommended. Otherwise, the value 0 is recommended. 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).

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:
handle has not been initialized.
handle has been corrupted.
handle is a handle to an unknown data structure.
An unexpected error has been triggered by this routine. Please contact NAG.
See Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See Section 9 in the Introduction to the NAG Library FL Interface for further information.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
g22zaf is not threaded in any implementation.

9 Further Comments


10 Example

See the example for g22yaf.