mpi_type_get_name.3

MPI stands for the Message Passing Interface. Written by the MPI Forum (a large committee comprising

.\"Copyright 2006, Sun Microsystems, Inc.
.\"Copyright (c) 1996 Thinking Machines
.TH MPI_Type_get_name 3OpenMPI "September 2006" "Open MPI 1.2" " "
.SH NAME
\fBMPI_Type_get_name\fP \- Gets the name of a data type. 

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Type_get_name(MPI_Datatype \fItype\fP, char *\fItype_name\fP, 
	int *\fIresultlen\fP)

.SH Fortran Syntax
.nf
INCLUDE 'mpif.h'
TYPE_GET_NAME(\fITYPE, TYPE_NAME, RESULTLEN, IERROR\fP)
	INTEGER	\fITYPE, RESULTLEN, IERROR \fP
	CHARACTER*(*) \fITYPE_NAME\fP

.SH C++ Syntax
.nf
#include <mpi.h>
void MPI::Datatype::Get_name(char* \fItype_name\fP, int& \fIresultlen\fP) 
	const

.SH INPUT PARAMETER
.ft R
.TP 1i
type
Data type whose name is to be returned (handle). 

.SH OUTPUT PARAMETERS
.ft R
.TP 1i
type_name
The name previously stored on the data type, or an empty string if not such name exists (string).
.TP 1i
resultlen
Length of returned name (integer).
.TP 1i
IERROR
Fortran only: Error status (integer). 

.SH DESCRIPTION
.ft R
MPI_Type_get_name returns the printable identifier associated with an MPI data type. 

.SH ERRORS
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.
.sp
Before the error value is returned, the current MPI error handler is
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.  

.SH SEE ALSO
.ft R
.sp
MPI_Type_set_name
.br

' @(#)MPI_Type_get_name.3 1.17 06/03/09