.\" -*- nroff -*- .\" Copyright 2010 Cisco Systems, Inc. All rights reserved. .\" Copyright 2006-2008 Sun Microsystems, Inc. .\" Copyright (c) 1996 Thinking Machines Corporation .\" $COPYRIGHT$ .TH MPI_Win_get_errhandler 3 "Sep 30, 2023" "4.1.6" "Open MPI" .SH NAME \fBMPI_Win_get_errhandler\fP \- Retrieves the error handler currently associated with a window. .SH SYNTAX .ft R .SH C Syntax .nf #include int MPI_Win_get_errhandler(MPI_Win \fIwin\fP, MPI_Errhandler *\fIerrhandler\fP) .fi .SH Fortran Syntax .nf USE MPI ! or the older form: INCLUDE 'mpif.h' MPI_WIN_GET_ERRHANDLER(\fIWIN, ERRHANDLER, IERROR\fP) INTEGER \fIWIN, ERRHANDLER, IERROR\fP .fi .SH Fortran 2008 Syntax .nf USE mpi_f08 MPI_Win_get_errhandler(\fIwin\fP, \fIerrhandler\fP, \fIierror\fP) TYPE(MPI_Win), INTENT(IN) :: \fIwin\fP TYPE(MPI_Errhandler), INTENT(OUT) :: \fIerrhandler\fP INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP .fi .SH C++ Syntax .nf #include MPI::Errhandler MPI::Win::Get_errhandler() const .fi .SH INPUT PARAMETER .ft R .TP 1i win Window (handle). .SH OUTPUT PARAMETERS .ft R .TP 1i errhandler Error handler currently associated with window (handle). .TP 1i IERROR Fortran only: Error status (integer). .SH DESCRIPTION .ft R MPI_Win_get_errhandler retrieves the error handler currently associated with a window. .SH 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. .sp 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.