1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_get_view 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_get_view\fP \- Returns the process's view of data in the file. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .nf |
---|
10 | C Syntax |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_File_get_view(MPI_File \fIfh\fP, MPI_Offset \fI*disp\fP, |
---|
13 | MPI_Datatype \fI*etype\fP, MPI_Datatype \fI*filetype\fP, |
---|
14 | char \fI*datarep\fP) |
---|
15 | |
---|
16 | Fortran Syntax (see FORTRAN 77 NOTES) |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_FILE_GET_VIEW(\fIFH\fP,\fI DISP\fP,\fI ETYPE\fP, |
---|
19 | \fI FILETYPE\fP, \fIDATAREP\fP, \fI IERROR\fP) |
---|
20 | INTEGER \fIFH, ETYPE, FILETYPE, IERROR\fP |
---|
21 | CHARACTER*(*) \fIDATAREP\fP |
---|
22 | INTEGER(KIND=MPI_OFFSET_KIND) \fIDISP\fP |
---|
23 | |
---|
24 | .SH C++ Syntax |
---|
25 | .nf |
---|
26 | #include <mpi.h> |
---|
27 | void MPI::File::Get_view(MPI::Offset& \fIdisp\fP, |
---|
28 | MPI::Datatype& \fIetype\fP, |
---|
29 | MPI::Datatype& \fIfiletype\fP, char* \fIdatarep\fP) const |
---|
30 | |
---|
31 | .SH INPUT PARAMETER |
---|
32 | .ft R |
---|
33 | .TP 1i |
---|
34 | fh |
---|
35 | File handle (handle). |
---|
36 | |
---|
37 | .SH OUTPUT PARAMETERS |
---|
38 | .ft R |
---|
39 | .TP 1i |
---|
40 | disp |
---|
41 | Displacement (integer). |
---|
42 | .TP 1i |
---|
43 | etype |
---|
44 | Elementary data type (handle). |
---|
45 | .TP 1i |
---|
46 | filetype |
---|
47 | File type (handle). See Restrictions, below. |
---|
48 | .TP 1i |
---|
49 | datarep |
---|
50 | Data representation (string). |
---|
51 | .TP 1i |
---|
52 | IERROR |
---|
53 | Fortran only: Error status (integer). |
---|
54 | |
---|
55 | .SH DESCRIPTION |
---|
56 | .ft R |
---|
57 | The MPI_File_get_view routine returns the process's view of the data |
---|
58 | in the file. The current values of the displacement, etype, and |
---|
59 | filetype are returned in |
---|
60 | .I disp, |
---|
61 | .I etype, |
---|
62 | and |
---|
63 | .I filetype, |
---|
64 | respectively. |
---|
65 | .sp |
---|
66 | The MPI_File_get_view interface allows the user to pass a data-representation string via the \fIdatarep\fP argument. |
---|
67 | |
---|
68 | .SH FORTRAN 77 NOTES |
---|
69 | .ft R |
---|
70 | The MPI standard prescribes portable Fortran syntax for |
---|
71 | the \fIDISP\fP argument only for Fortran 90. FORTRAN 77 |
---|
72 | users may use the non-portable syntax. |
---|
73 | .sp |
---|
74 | .nf |
---|
75 | INTEGER*MPI_OFFSET_KIND \fIDISP\fP |
---|
76 | .fi |
---|
77 | .sp |
---|
78 | where MPI_OFFSET_KIND is a constant defined in mpif.h |
---|
79 | and gives the length of the declared integer in bytes. |
---|
80 | |
---|
81 | .SH ERRORS |
---|
82 | 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. |
---|
83 | .sp |
---|
84 | Before the error value is returned, the current MPI error handler is |
---|
85 | 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. |
---|
86 | |
---|