MPI_Type_set_name - Set a name on a datatype
SYNOPSIS
#include <mpi.h>
int
MPI_Type_set_name(MPI_Datatype type, char *name)
INPUT PARAMETERS
type - MPI datatype
name - Pointer to the name of dataname
NOTES
This function associates a name with a datatype, which can
be useful for debugging purposes. The function
MPI_Type_get_name can be used to retrieve name that was
previously set with MPI_Type_set_name .
Named predefined datatypes have the default names of the
datatype name. For example, MPI_WCHAR has the default name
of MPI_WCHAR . It is legal to change any of these names
with calls to MPI_Type_set_name .
Names passed in C must include the null terminator, and
can be of maximum length MPI_MAX_OBJECT_NAME (including
the null terminator). Names passed in Fortran can also
have a maximum length of MPI_MAX_OBJECT_NAME .
Setting a name on a datatype that already has a name asso
ciated with it replaces the old name.
ERRORS
If an error occurs in an MPI function, the current MPI
error handler is called to handle it. By default, this
error handler aborts the MPI job. The error handler may
be changed with MPI_Errhandler_set ; the predefined error
handler MPI_ERRORS_RETURN may be used to cause error val
ues to be returned (in C and Fortran; this error handler
is less useful in with the C++ MPI bindings. The prede
fined error handler MPI::ERRORS_THROW_EXCEPTIONS should be
used in C++ if the error value needs to be recovered).
Note that MPI does not guarantee that an MPI program can
continue past an error.
All MPI routines (except MPI_Wtime and MPI_Wtick ) return
an error value; C routines as the value of the function
and Fortran routines in the last argument. The C++ bind
ings for MPI do not return error values; instead, error
values are communicated by throwing exceptions of type
MPI::Exception (but not by default). Exceptions are only
thrown if the error value is not MPI::SUCCESS .
while MPI functions will return upon an error, there will
be no way to recover what the actual error value was.
MPI_SUCCESS
- No error; MPI routine completed successfully.
MPI_ERR_TYPE
- Invalid datatype argument. May be an uncommitted
MPI_Datatype (see MPI_Type_commit ).
MPI_ERR_ARG
- Invalid argument. Some argument is invalid and
is not identified by a specific error class. This
is typically a NULL pointer or other such error.
SEE ALSO
MPI_Comm_set_name, MPI_Comm_get_name, MPI_Type_get_name,
MPI_Win_get_name, MPI_Win_set_name
MORE INFORMATION
For more information, please see the official MPI Forum
web site, which contains the text of both the MPI-1 and
MPI-2 standards. These documents contain detailed infor
mation about each MPI function (most of which is not
duplicated in these man pages).
http://www.mpi-forum.org/
LOCATION
tsetname.c
Man(1) output converted with
man2html