Rev | Line | |
---|
[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
| 3 | .TH MPI_File_get_group 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_File_get_group\fP \- Returns a duplicate of the process group of a file. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .nf |
---|
| 10 | C Syntax |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_File_get_group(MPI_File \fIfh\fP, MPI_Group \fI*group\fP) |
---|
| 13 | |
---|
| 14 | Fortran Syntax |
---|
| 15 | INCLUDE 'mpif.h' |
---|
| 16 | MPI_FILE_GET_GROUP(\fIFH\fP,\fI GROUP\fP, \fI IERROR\fP) |
---|
| 17 | INTEGER FH, GROUP, IERROR |
---|
| 18 | |
---|
| 19 | .SH C++ Syntax |
---|
| 20 | .nf |
---|
| 21 | #include <mpi.h> |
---|
| 22 | MPI::Group MPI::File::Get_group() const |
---|
| 23 | |
---|
| 24 | .SH INPUT PARAMETER |
---|
| 25 | .ft R |
---|
| 26 | .TP 1i |
---|
| 27 | fh |
---|
| 28 | File handle (handle). |
---|
| 29 | |
---|
| 30 | .SH OUTPUT PARAMETERS |
---|
| 31 | .TP 1i |
---|
| 32 | group |
---|
| 33 | Group that opened the file (handle). |
---|
| 34 | .TP 1i |
---|
| 35 | IERROR |
---|
| 36 | Fortran only: Error status (integer). |
---|
| 37 | |
---|
| 38 | .SH DESCRIPTION |
---|
| 39 | .ft R |
---|
| 40 | MPI_File_get_group returns a duplicate of the group of the communicator |
---|
| 41 | used to open the file associated with |
---|
| 42 | .I fh. |
---|
| 43 | The group is returned in |
---|
| 44 | .I group. |
---|
| 45 | The user is responsible for freeing |
---|
| 46 | .I group, |
---|
| 47 | using MPI_Group_free. |
---|
| 48 | |
---|
| 49 | .SH ERRORS |
---|
| 50 | 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. |
---|
| 51 | .sp |
---|
| 52 | Before the error value is returned, the current MPI error handler is |
---|
| 53 | 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. |
---|
| 54 | |
---|
Note: See
TracBrowser
for help on using the repository browser.