Open MPI logo

MPI_Info_free(3) man page (version 1.8.1)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Info_free - Frees an info object.

Syntax

C Syntax


#include <mpi.h>
int MPI_Info_free(MPI_Info *info)

Fortran Syntax


INCLUDE ’mpif.h’
MPI_INFO_FREE(INFO, IERROR)
    INTEGER        INFO, IERROR

C++ Syntax


#include <mpi.h>
void MPI::Info::Free()

Input/Output Parameter

info
Info object (handle).

Output Parameter

IERROR
Fortran only: Error status (integer).

Description

MPI_Info_free frees info and sets it to MPI_INFO_NULL.

Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI::Exception object.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

See Also

MPI_Info_create
MPI_Info_delete
MPI_Info_dup
MPI_Info_get
MPI_Info_set


Table of Contents

« Return to documentation listing