Open MPI logo

MPI_File_get_amode(3) man page (version 1.4.5)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents


MPI_File_get_amode - Returns access mode associated with an open file.


C Syntax
    #include <mpi.h>
    int MPI_File_get_amode(MPI_File fh, int *amode)

Fortran Syntax

    INCLUDE ’mpif.h’
             INTEGER    FH, AMODE, IERROR

C++ Syntax

#include <mpi.h>
int MPI::File::Get_amode() const

Input Parameter

File handle (handle).

Output Parameters

File access mode used to open the file (integer).
Fortran only: Error status (integer).


MPI_File_get_amode returns, in amode, the access mode associated with the open file fh.


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.

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.

Table of Contents

« Return to documentation listing