Open MPI logo

MPI_File_set_errhandler(3) man page (version 1.2.9)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



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

       INCLUDE 'mpif.h'
       MPI_FILE_SET_ERRHANDLER(FILE, ERRHANDLER, IERROR)
            INTEGER   FILE, ERRHANDLER, 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++  func-
       tions  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.

« Return to documentation listing