[97] | 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
| 2 | .\"Copyright (c) 1996 Thinking Machines |
---|
| 3 | .TH MPI_Type_get_name 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
| 4 | .SH NAME |
---|
| 5 | \fBMPI_Type_get_name\fP \- Gets the name of a data type. |
---|
| 6 | |
---|
| 7 | .SH SYNTAX |
---|
| 8 | .ft R |
---|
| 9 | .SH C Syntax |
---|
| 10 | .nf |
---|
| 11 | #include <mpi.h> |
---|
| 12 | int MPI_Type_get_name(MPI_Datatype \fItype\fP, char *\fItype_name\fP, |
---|
| 13 | int *\fIresultlen\fP) |
---|
| 14 | |
---|
| 15 | .SH Fortran Syntax |
---|
| 16 | .nf |
---|
| 17 | INCLUDE 'mpif.h' |
---|
| 18 | TYPE_GET_NAME(\fITYPE, TYPE_NAME, RESULTLEN, IERROR\fP) |
---|
| 19 | INTEGER \fITYPE, RESULTLEN, IERROR \fP |
---|
| 20 | CHARACTER*(*) \fITYPE_NAME\fP |
---|
| 21 | |
---|
| 22 | .SH C++ Syntax |
---|
| 23 | .nf |
---|
| 24 | #include <mpi.h> |
---|
| 25 | void MPI::Datatype::Get_name(char* \fItype_name\fP, int& \fIresultlen\fP) |
---|
| 26 | const |
---|
| 27 | |
---|
| 28 | .SH INPUT PARAMETER |
---|
| 29 | .ft R |
---|
| 30 | .TP 1i |
---|
| 31 | type |
---|
| 32 | Data type whose name is to be returned (handle). |
---|
| 33 | |
---|
| 34 | .SH OUTPUT PARAMETERS |
---|
| 35 | .ft R |
---|
| 36 | .TP 1i |
---|
| 37 | type_name |
---|
| 38 | The name previously stored on the data type, or an empty string if not such name exists (string). |
---|
| 39 | .TP 1i |
---|
| 40 | resultlen |
---|
| 41 | Length of returned name (integer). |
---|
| 42 | .TP 1i |
---|
| 43 | IERROR |
---|
| 44 | Fortran only: Error status (integer). |
---|
| 45 | |
---|
| 46 | .SH DESCRIPTION |
---|
| 47 | .ft R |
---|
| 48 | MPI_Type_get_name returns the printable identifier associated with an MPI data type. |
---|
| 49 | |
---|
| 50 | .SH ERRORS |
---|
| 51 | 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. |
---|
| 52 | .sp |
---|
| 53 | Before the error value is returned, the current MPI error handler is |
---|
| 54 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error. |
---|
| 55 | |
---|
| 56 | .SH SEE ALSO |
---|
| 57 | .ft R |
---|
| 58 | .sp |
---|
| 59 | MPI_Type_set_name |
---|
| 60 | .br |
---|
| 61 | |
---|