2016-11-22 15:03:20 -08:00
.\" -*- nroff -*-
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" Copyright 2016 Research Organization for Information Science
.\" and Technology (RIST). All rights reserved.
2020-02-18 22:42:21 -08:00
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
2016-11-22 15:03:20 -08:00
.\" $COPYRIGHT$
.TH MPI_File_get_errhandler 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_File_get_errhandler \fP \- Gets the error handler for a file.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_File_get_errhandler(MPI_File \fIfile\fP, MPI_Errhandler\fI
*errhandler\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_GET_ERRHANDLER(\fIFILE, ERRHANDLER, IERROR\fP)
INTEGER \fIFILE, ERRHANDLER, IERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_File_get_errhandler(\fIfile\fP, \fIerrhandler\fP, \fIierror\fP)
TYPE(MPI_File), INTENT(IN) :: \fIfile\fP
TYPE(MPI_Errhandler), INTENT(OUT) :: \fIerrhandler\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH INPUT PARAMETER
.ft R
.TP 1i
file
File (handle).
.SH OUTPUT PARAMETERS
.ft R
.TP 1i
errhandler
MPI error handler currently associated with file (handle).
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH DESCRIPTION
.ft R
Returns in \fIerrhandler\fP (a handle to) the error handler that is currently associated with file \fIfile\fP.
.SH ERRORS
2020-02-18 22:42:21 -08:00
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.
2016-11-22 15:03:20 -08:00
.sp
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.
