.\" -*- nroff -*- .\" Copyright 2010 Cisco Systems, Inc. All rights reserved. .\" Copyright 2006-2008 Sun Microsystems, Inc. .\" Copyright (c) 1996 Thinking Machines Corporation .\" Copyright 2015-2016 Research Organization for Information Science .\" and Technology (RIST). All rights reserved. .\" $COPYRIGHT$ .TH MPI_File_get_amode 3 "Sep 30, 2023" "4.1.6" "Open MPI" .SH NAME \fBMPI_File_get_amode\fP \- Returns access mode associated with an open file. .SH SYNTAX .ft R .nf .SH C Syntax .nf #include int MPI_File_get_amode(MPI_File \fIfh\fP, int \fI*amode\fP) .fi .SH Fortran Syntax .nf USE MPI ! or the older form: INCLUDE 'mpif.h' MPI_FILE_GET_AMODE(\fIFH\fP, \fIAMODE\fP, \fIIERROR\fP) INTEGER \fIFH, AMODE, IERROR\fP .fi .SH Fortran 2008 Syntax .nf USE mpi_f08 MPI_File_get_amode(\fIfh\fP, \fIamode\fP, \fIierror\fP) TYPE(MPI_File), INTENT(IN) :: \fIfh\fP INTEGER, INTENT(OUT) :: \fIamode\fP INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP .fi .SH C++ Syntax .nf #include int MPI::File::Get_amode() const .fi .SH INPUT PARAMETER .ft R .TP 1i fh File handle (handle). .SH OUTPUT PARAMETERS .ft R .TP 1i amode File access mode used to open the file (integer). .TP 1i IERROR Fortran only: Error status (integer). .SH DESCRIPTION .ft R MPI_File_get_amode returns, in .I amode, the access mode associated with the open file .I fh. .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. 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.