Open MPI logo

MPI_File_get_atomicity(3) man page (version 1.3.4)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing



NAME

       MPI_File_get_atomicity  -  Returns  current  consistency  semantics for
       data-access operations.

SYNTAX

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

       Fortran Syntax
           INCLUDE 'mpif.h'
           MPI_FILE_GET_ATOMICITY(FH, FLAG, IERROR)
            INTEGER FH, IERROR
            LOGICAL FLAG

C++ Syntax

       #include <mpi.h>
       bool MPI::File::Get_atomicity() const

INPUT PARAMETER

       fh        File handle (handle).

OUTPUT PARAMETER

       flag      true if atomic mode is enabled, false if  nonatomic  mode  is
                 enabled (boolean).

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

       MPI_File_get_atomicity  returns  the  current consistency semantics for
       data access operations on the set of file handles created by  one  col-
       lective  MPI_File_open.  If  flag  is  true,  atomic  mode is currently
       enabled; if flag is false, nonatomic mode is currently enabled.

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++ func-
       tions 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.

1.3.4                            Nov 11, 2009        MPI_File_get_atomicity(3)

« Return to documentation listing