1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_iread 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_iread\fP \- Reads a file starting at the location specified by the individual file pointer (nonblocking, noncollective). |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .nf |
---|
10 | C Syntax |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_File_iread(MPI_File \fIfh\fP, void \fI*buf\fP, int \fIcount\fP, |
---|
13 | MPI_Datatype \fIdatatype\fP, MPI_Request \fI*request\fP) |
---|
14 | |
---|
15 | Fortran Syntax |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_FILE_IREAD(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fIREQUEST\fP,\fI IERROR\fP) |
---|
18 | <type> BUF(*) |
---|
19 | INTEGER FH, COUNT, DATATYPE, REQUEST, IERROR |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | MPI::Request MPI::File::Iread(void* \fIbuf\fP, int \fIcount\fP, |
---|
25 | const MPI::Datatype& \fIdatatype\fP) |
---|
26 | |
---|
27 | .SH INPUT/OUTPUT PARAMETER |
---|
28 | .ft R |
---|
29 | .TP 1i |
---|
30 | fh |
---|
31 | File handle (handle). |
---|
32 | |
---|
33 | .SH INPUT PARAMETERS |
---|
34 | .ft R |
---|
35 | .TP 1i |
---|
36 | count |
---|
37 | Number of elements in the buffer (integer). |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | datatype |
---|
41 | Data type of each buffer element (handle). |
---|
42 | |
---|
43 | .SH OUTPUT PARAMETERS |
---|
44 | .ft R |
---|
45 | .TP 1i |
---|
46 | buf |
---|
47 | Initial address of buffer (choice). |
---|
48 | .ft R |
---|
49 | .TP 1i |
---|
50 | request |
---|
51 | Request object (handle). |
---|
52 | .TP 1i |
---|
53 | IERROR |
---|
54 | Fortran only: Error status (integer). |
---|
55 | |
---|
56 | .SH DESCRIPTION |
---|
57 | .ft R |
---|
58 | MPI_File_iread is a nonblocking version of MPI_File_read. It attempts to read from the file associated with |
---|
59 | .I fh |
---|
60 | at the current individual file pointer position maintained by the system in which a total number of |
---|
61 | .I count |
---|
62 | data items having |
---|
63 | .I datatype |
---|
64 | type are read 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_iread 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. It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened. |
---|
73 | |
---|
74 | .SH ERRORS |
---|
75 | 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. |
---|
76 | .sp |
---|
77 | Before the error value is returned, the current MPI error handler is |
---|
78 | 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. |
---|
79 | |
---|