1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_File_get_position 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_File_get_position\fP \- Returns the current position of the individual file pointer. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .nf |
---|
10 | C Syntax |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_File_get_position(MPI_File \fIfh\fP, MPI_Offset \fI*offset\fP) |
---|
13 | |
---|
14 | Fortran Syntax (see FORTRAN 77 NOTES) |
---|
15 | INCLUDE 'mpif.h' |
---|
16 | MPI_FILE_GET_POSITION(\fIFH\fP,\fI OFFSET\fP,\fI IERROR\fP) |
---|
17 | INTEGER \fIFH, IERROR\fP |
---|
18 | INTEGER(KIND=MPI_OFFSET_KIND) \fIOFFSET\fP |
---|
19 | |
---|
20 | .SH C++ Syntax |
---|
21 | .nf |
---|
22 | #include <mpi.h> |
---|
23 | MPI::Offset MPI::File::Get_position() const |
---|
24 | |
---|
25 | .SH INPUT PARAMETER |
---|
26 | .ft R |
---|
27 | .TP 1i |
---|
28 | fh |
---|
29 | File handle (handle). |
---|
30 | |
---|
31 | .SH OUTPUT PARAMETERS |
---|
32 | .ft R |
---|
33 | .TP 1i |
---|
34 | offset |
---|
35 | Offset of the individual file pointer (integer). |
---|
36 | .TP 1i |
---|
37 | IERROR |
---|
38 | Fortran only: Error status (integer). |
---|
39 | |
---|
40 | .SH DESCRIPTION |
---|
41 | .ft R |
---|
42 | MPI_File_get_position returns, in |
---|
43 | .I offset, |
---|
44 | the current position of the individual file pointer in |
---|
45 | .I etype |
---|
46 | units relative to the current displacement and file type. |
---|
47 | |
---|
48 | .SH FORTRAN 77 NOTES |
---|
49 | .ft R |
---|
50 | The MPI standard prescribes portable Fortran syntax for |
---|
51 | the \fIOFFSET\fP argument only for Fortran 90. Sun FORTRAN 77 |
---|
52 | users may use the non-portable syntax |
---|
53 | .sp |
---|
54 | .nf |
---|
55 | INTEGER*MPI_OFFSET_KIND \fIOFFSET\fP |
---|
56 | .fi |
---|
57 | .sp |
---|
58 | where MPI_ADDRESS_KIND is a constant defined in mpif.h |
---|
59 | and gives the length of the declared integer in bytes. |
---|
60 | |
---|
61 | .SH ERRORS |
---|
62 | 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. |
---|
63 | .sp |
---|
64 | Before the error value is returned, the current MPI error handler is |
---|
65 | 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. |
---|
66 | |
---|