S3L_free

Description

S3L_free deallocates the memory reserved for a parallel S3L array and undefines the associated array handle.

If memory was allocated for the array by the user rather than by S3L, S3L_free destroys the array handle, but does not deallocate the memory. This situation can arise when S3L_declare_detailed() is invoked with the atype option set to S3L_DONOT_ALLOCATE.

Syntax

The C and Fortran syntax for S3L_free are shown below.

C/C++ Syntax

Example 7-15

#include <s3l/s3l-c.h>
#include <s3l/s3l_errno-c.h>
int
S3L_free(a)
    S3L_array_t        *a

F77/F90 Syntax

Example 7-16

include `s3l/s3l-f.h
include `s3l/s3l_errno-f.h'
subroutine
S3L_free(a, ier)
    integer*8          a
    integer*4          ier

Input

S3L_free accepts the following argument as input:

• a - Handle for the parallel S3L array that is to be deallocated. This handle was returned by a previous call to S3L_declare, S3L_declare_detailed.

Output

S3L_free uses the following argument for output:

• ier (Fortran only) - When called from a Fortran program, S3L_free returns error status in ier.

Error Handling

On success, S3L_free returns S3L_SUCCESS.

On error, the following error code may be returned:

• S3L_ERR_ARG_ARRAY - a is a NULL pointer (C/C++) or 0 (F77/F90).

Examples

../examples/s3l/io/ex_print1.c
../examples/s3l/io-f/ex_print1.f

Related Functions

S3L_declare(3)
S3L_declare_detailed(3)