MPI_File_set_errhandler

NAME

MPI_File_set_errhandler - Sets the error handler for a file.

SYNTAX

C Syntax

#include <mpi.h>
int MPI_File_set_errhandler(MPI_File file, MPI_Errhandler

errhandler)

Fortran Syntax

USE MPI
! or the older form: INCLUDE ’mpif.h’
MPI_FILE_SET_ERRHANDLER(FILE, ERRHANDLER, IERROR)

	INTEGER			FILE, ERRHANDLER, IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_File_set_errhandler(file, errhandler, ierror)

	TYPE(MPI_File), INTENT(IN) :: file
	TYPE(MPI_Errhandler), INTENT(IN) :: errhandler
	INTEGER, OPTIONAL, INTENT(OUT) :: ierror

C++ Syntax

#include <mpi.h>
void MPI::File::Set_errhandler(const MPI::Errhandler& errhandler)

INPUT/OUTPUT PARAMETER

file

File (handle).

INPUT PARAMETER

errhandler

New error handler for file (handle).

OUTPUT PARAMETER

IERROR

Fortran only: Error status (integer).

DESCRIPTION

Attaches a new error handler to a file. The error handler must be either a predefined error handler or an error handler created by a call to MPI_File_create_errhandler.

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. For MPI I/O function errors, the default error handler is set to MPI_ERRORS_RETURN. The error handler may be changed with MPI_File_set_errhandler; the predefined error handler MPI_ERRORS_ARE_FATAL may be used to make I/O errors fatal. Note that MPI does not guarantee that an MPI program can continue past an error.