1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_read_shared 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_read_shared\fP \- Reads a file using the shared file pointer (blocking, noncollective). |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .nf |
---|
10 | C Syntax |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_File_read_shared(MPI_File \fIfh\fP, void \fI*buf\fP, int \fIcount\fP, |
---|
13 | MPI_Datatype \fIdatatype\fP, MPI_Status \fI*status\fP) |
---|
14 | |
---|
15 | Fortran Syntax |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_FILE_READ_SHARED(\fIFH\fP, \fIBUF\fP, \fICOUNT\fP, \fIDATATYPE\fP, \fISTATUS\fP, |
---|
18 | \fIIERROR\fP) |
---|
19 | <TYPE> BUF(*) |
---|
20 | INTEGER FH, COUNT, DATATYPE, |
---|
21 | STATUS(MPI_STATUS_SIZE), IERROR |
---|
22 | |
---|
23 | .SH C++ Syntax |
---|
24 | .nf |
---|
25 | #include <mpi.h> |
---|
26 | void MPI::File::Read_shared(void* \fIbuf\fP, int \fIcount\fP, |
---|
27 | const MPI::Datatype& \fIdatatype\fP, MPI::Status& \fIstatus\fP) |
---|
28 | |
---|
29 | void MPI::File::Read_shared(void* \fIbuf\fP, int \fIcount\fP, |
---|
30 | const MPI::Datatype& \fIdatatype\fP) |
---|
31 | |
---|
32 | .SH INPUT/OUTPUT PARAMETER |
---|
33 | .ft R |
---|
34 | .TP 1i |
---|
35 | fh |
---|
36 | File handle (handle). |
---|
37 | |
---|
38 | .SH INPUT PARAMETERS |
---|
39 | .ft R |
---|
40 | .TP 1i |
---|
41 | count |
---|
42 | Number of elements in buffer (integer) |
---|
43 | .ft R |
---|
44 | .TP 1i |
---|
45 | datatype |
---|
46 | Data type of each buffer element (handle). |
---|
47 | |
---|
48 | .SH OUTPUT PARAMETERS |
---|
49 | .ft R |
---|
50 | .TP 1i |
---|
51 | buf |
---|
52 | Initial address of buffer (choice). |
---|
53 | .ft R |
---|
54 | .TP 1i |
---|
55 | status |
---|
56 | Status object (status). |
---|
57 | .TP 1i |
---|
58 | IERROR |
---|
59 | Fortran only: Error status (integer). |
---|
60 | |
---|
61 | .SH DESCRIPTION |
---|
62 | .ft R |
---|
63 | 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. |
---|
64 | |
---|
65 | .SH ERRORS |
---|
66 | 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. |
---|
67 | .sp |
---|
68 | Before the error value is returned, the current MPI error handler is |
---|
69 | 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. |
---|
70 | |
---|