This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_File_get_amode(3OpenMPI)                                                    MPI_File_get_amode(3OpenMPI)



NAME
       MPI_File_get_amode - Returns access mode associated with an open file.


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

       Fortran Syntax
           INCLUDE 'mpif.h'
           MPI_FILE_GET_AMODE(FH, AMODE,  IERROR)
                  INTEGER  FH, AMODE, IERROR


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


INPUT PARAMETER
       fh        File handle (handle).


OUTPUT PARAMETERS
       amode     File access mode used to open the file (integer).

       IERROR    Fortran only: Error status (integer).


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


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.

       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.




Open MPI 1.2                                   September 2006                   MPI_File_get_amode(3OpenMPI)