MPIFileiread(3OpenMPI) MPIFileiread(3OpenMPI)

NAME
       MMPPIIFFiilleeiirreeaadd - Reads a file starting at the location specified by the
       individual file pointer (nonblocking, noncollective).


SSYYNNTTAAXX
       C Syntax
           #include 
           int MPIFileiread(MPIFile fh, void  *buf, int  count,
                  MPIDatatype  datatype, MPIRequest  *request)

       Fortran Syntax
           INCLUDE 'mpif.h'
           MPIFILEIREAD(FH, BUF, COUNT, DATATYPE, REQUEST, IERROR)
                          BUF(*)
                 INTEGER        FH, COUNT, DATATYPE, REQUEST, IERROR


CC++++ SSyynnttaaxx
       #include 
       MPI::Request MPI::File::Iread(void* buf, int count,
            const MPI::Datatype& datatype)


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       fh        File handle (handle).


IINNPPUUTT PPAARRAAMMEETTEERRSS
       count     Number of elements in the buffer (integer).

       datatype  Data type of each buffer element (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       buf       Initial address of buffer (choice).

       request   Request object (handle).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPIFileiread is a nonblocking version of MPIFileread.  It  attempts
       to read from the file associated with fh at the current individual file
       pointer position maintained by the system in which a  total  number  of
       count  data items having datatype type  are read into the user's buffer
       buf.  The data is taken out of those parts of the file specified by the
       current  view.  MPIFileiread  stores the number of data-type elements
       actually read in status.  All other fields of status are undefined.  It
       is  erroneous  to  call  this  function if MPIMODESEQUENTIAL mode was
       specified when the file was opened.


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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  MPIERRORSRETURN.  The  error  handler   may   be   changed   with
       MPIFileseterrhandler;      the      predefined     error     handler
       MPIERRORSAREFATAL 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        MPIFileiread(3OpenMPI)