MPI_Win_call_errhandler(3) | Open MPI | MPI_Win_call_errhandler(3) |
NAME¶
MPI_Win_call_errhandler - Passes the supplied error code to the error handler assigned to a window
SYNTAX¶
C Syntax¶
#include <mpi.h> int MPI_Win_call_errhandler(MPI_Win win, int errorcode)
Fortran Syntax¶
USE MPI ! or the older form: INCLUDE 'mpif.h' MPI_WIN_CALL_ERRHANDLER(WIN, ERRORCODE, IERROR) INTEGER WIN, ERRORCODE, IERROR
Fortran 2008 Syntax¶
USE mpi_f08 MPI_Win_call_errhandler(win, errorcode, ierror) TYPE(MPI_Win), INTENT(IN) :: win INTEGER, INTENT(IN) :: errorcode INTEGER, OPTIONAL, INTENT(OUT) :: ierror
C++ Syntax¶
#include <mpi.h> void MPI::Win::Call_errhandler(int errorcode) const
INPUT PARAMETERS¶
OUTPUT PARAMETER¶
- IERROR
- Fortran only: Error status (integer).
DESCRIPTION¶
This function invokes the error handler assigned to the window win with the supplied error code errorcode. If the error handler was successfully called, the process is not aborted, and the error handler returns, this function returns MPI_SUCCESS.
NOTES¶
Users should note that the default error handler is MPI_ERRORS_ARE_FATAL. Thus, calling this function will abort the window processes if the default error handler has not been changed for this window.
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.
See the MPI man page for a full list of MPI error codes.
SEE ALSO¶
MPI_Win_create_errhandler MPI_Win_set_errhandler
September 30, 2023 | 4.1.6 |