[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_File_read_all 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_File_read_all\fP \- Reads a file starting at the locations specified by individual file pointers (blocking, collective). |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .nf |
---|
| 10 | C Syntax |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_File_read_all(MPI_File \fIfh\fP, void \fI*buf\fP, |
---|
| 13 | int \fIcount\fP, MPI_Datatype \fIdatatype\fP, MPI_Status \fI*status\fP) |
---|
| 14 | |
---|
| 15 | Fortran Syntax |
---|
| 16 | INCLUDE 'mpif.h' |
---|
| 17 | MPI_FILE_READ_ALL(\fI FH\fP, \fI BUF\fP, \fICOUNT\fP, |
---|
| 18 | \fI DATATYPE\fP, \fISTATUS\fP, \fI IERROR\fP) |
---|
| 19 | <type> BUF(*) |
---|
| 20 | INTEGER FH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE), |
---|
| 21 | IERROR |
---|
| 22 | |
---|
| 23 | .SH C++ Syntax |
---|
| 24 | .nf |
---|
| 25 | #include <mpi.h> |
---|
| 26 | void MPI::File::Read_all(void* \fIbuf\fP, int \fIcount\fP, |
---|
| 27 | const MPI::Datatype& \fIdatatype\fP, MPI::Status& \fIstatus\fP) |
---|
| 28 | |
---|
| 29 | void MPI::File::Read_all(void* \fIbuf\fP, int \fIcount\fP, |
---|
| 30 | const MPI::Datatype& \fIdatatype\fP) |
---|
| 31 | |
---|
| 32 | .SH INPUT PARAMETERS |
---|
| 33 | .ft R |
---|
| 34 | .TP 1i |
---|
| 35 | fh |
---|
| 36 | File handle (handle). |
---|
| 37 | .TP 1i |
---|
| 38 | count |
---|
| 39 | Number of elements in buffer (integer). |
---|
| 40 | .TP 1i |
---|
| 41 | datatype |
---|
| 42 | Data type of each buffer element (handle). |
---|
| 43 | |
---|
| 44 | .SH OUTPUT PARAMETERS |
---|
| 45 | .ft R |
---|
| 46 | .TP 1i |
---|
| 47 | buf |
---|
| 48 | Initial address of buffer (choice). |
---|
| 49 | .TP 1i |
---|
| 50 | status |
---|
| 51 | Status object (status). |
---|
| 52 | .TP 1i |
---|
| 53 | IERROR |
---|
| 54 | Fortran only: Error status (integer). |
---|
| 55 | |
---|
| 56 | .SH DESCRIPTION |
---|
| 57 | .ft R |
---|
| 58 | MPI_File_read_all is a collective routine that attempts to read from the file associated with |
---|
| 59 | .I fh |
---|
| 60 | (at the current individual file pointer position maintained by the system) a total number of |
---|
| 61 | .I count |
---|
| 62 | data items having |
---|
| 63 | .I datatype |
---|
| 64 | type into the user's buffer |
---|
| 65 | .I buf. |
---|
| 66 | The data is taken out of those parts of the |
---|
| 67 | file specified by the current view. MPI_File_read_all stores the |
---|
| 68 | number of data-type elements actually read in |
---|
| 69 | .I status. |
---|
| 70 | All other fields of |
---|
| 71 | .I status |
---|
| 72 | are undefined. |
---|
| 73 | .sp |
---|
| 74 | It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened. |
---|
| 75 | |
---|
| 76 | .SH ERRORS |
---|
| 77 | 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. |
---|
| 78 | .sp |
---|
| 79 | Before the error value is returned, the current MPI error handler is |
---|
| 80 | 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. |
---|
| 81 | |
---|
| 82 | |
---|