Poster of Linux kernelThe best gift for a Linux geek
MPI_File_read_shared

MPI_File_read_shared

Section: Open MPI (3) Updated: Oct 05, 2010
Local index Up
 

NAME

MPI_File_read_shared - Reads a file using the shared file pointer (blocking, noncollective).

 

SYNTAX

C Syntax
    #include <mpi.h>
    int MPI_File_read_shared(MPI_File fh, void *buf, int count, 
MPI_Datatype datatype, MPI_Status *status)

Fortran Syntax
    INCLUDE 'mpif.h'
    MPI_FILE_READ_SHARED(FH, BUF, COUNT, DATATYPE, STATUS, 
        IERROR)
                <TYPE>          BUF(*)
                INTEGER         FH, COUNT, DATATYPE, 
                                STATUS(MPI_STATUS_SIZE), IERROR

 

C++ Syntax

#include <mpi.h>
void MPI::File::Read_shared(void* buf, int count,
        const MPI::Datatype& datatype, MPI::Status& status)

void MPI::File::Read_shared(void* buf, int count,
        const MPI::Datatype& datatype)

 

INPUT/OUTPUT PARAMETER

fh
File handle (handle).

 

INPUT PARAMETERS

count
Number of elements in buffer (integer)
datatype
Data type of each buffer element (handle).

 

OUTPUT PARAMETERS

buf
Initial address of buffer (choice).
status
Status object (status).
IERROR
Fortran only: Error status (integer).

 

DESCRIPTION

MPI_File_read_shared is a blocking routine that uses the shared file pointer to read files. The order of serialization is not deterministic for this noncollective routine.

 

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.


 

Index

NAME
SYNTAX
C++ Syntax
INPUT/OUTPUT PARAMETER
INPUT PARAMETERS
OUTPUT PARAMETERS
DESCRIPTION
ERRORS

This document was created by man2html, using the manual pages.
Time: 21:50:38 GMT, April 16, 2011