MPI_Type_set_name(3)

1MPI_Type_set_name(3)                LAM/MPI               MPI_Type_set_name(3)
2
3
4

NAME

6       MPI_Type_set_name -  Set a name on a datatype
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Type_set_name(MPI_Datatype type, char *name)
12

INPUT PARAMETERS

14       type   - MPI datatype
15       name   - Pointer to the name of dataname
16
17

NOTES

19       This  function  associates  a name with a datatype, which can be useful
20       for debugging purposes.  The function MPI_Type_get_name can be used  to
21       retrieve name that was previously set with MPI_Type_set_name .
22
23
24       Named predefined datatypes have the default names of the datatype name.
25       For example, MPI_WCHAR has the default name of MPI_WCHAR .
26
27       It  is  legal  to  change  any   of   these   names   with   calls   to
28       MPI_Type_set_name .
29
30
31       Names passed in C must include the null terminator, and can be of maxi‐
32       mum length MPI_MAX_OBJECT_NAME (including the null terminator).   Names
33       passed in Fortran can also have a maximum length of MPI_MAX_OBJECT_NAME
34       .
35
36
37       Setting a name on a datatype that already has a name associated with it
38       replaces the old name.
39
40

ERRORS

42       If an error occurs in an MPI function, the current MPI error handler is
43       called to handle it.  By default, this error  handler  aborts  the  MPI
44       job.   The  error  handler may be changed with MPI_Errhandler_set ; the
45       predefined error handler MPI_ERRORS_RETURN may be used to  cause  error
46       values  to  be  returned  (in C and Fortran; this error handler is less
47       useful in with the C++ MPI  bindings.   The  predefined  error  handler
48       MPI::ERRORS_THROW_EXCEPTIONS  should  be used in C++ if the error value
49       needs to be recovered).  Note that MPI does not guarantee that  an  MPI
50       program can continue past an error.
51
52       All  MPI  routines  (except  MPI_Wtime  and MPI_Wtick ) return an error
53       value; C routines as the value of the function and Fortran routines  in
54       the  last  argument.  The C++ bindings for MPI do not return error val‐
55       ues; instead, error values are communicated by throwing  exceptions  of
56       type  MPI::Exception  (but not by default).  Exceptions are only thrown
57       if the error value is not MPI::SUCCESS .
58
59
60       Note that if the MPI::ERRORS_RETURN handler is set in  C++,  while  MPI
61       functions  will  return  upon an error, there will be no way to recover
62       what the actual error value was.
63       MPI_SUCCESS
64              - No error; MPI routine completed successfully.
65       MPI_ERR_TYPE
66              - Invalid datatype argument.  May be an uncommitted MPI_Datatype
67              (see MPI_Type_commit ).
68       MPI_ERR_ARG
69              - Invalid argument.  Some argument is invalid and is not identi‐
70              fied by a specific  error  class.   This  is  typically  a  NULL
71              pointer or other such error.
72
73

MORE INFORMATION

80       For more information, please see the official MPI Forum web site, which
81       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
82       ments contain detailed information about each  MPI  function  (most  of
83       which is not duplicated in these man pages).
84
85       http://www.mpi-forum.org/
86

LOCATION

88       tsetname.c
89
90
91
92LAM/MPI 7.1.2                      2/23/2006              MPI_Type_set_name(3)