MPI_Comm_get_name(3)

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

NAME

6       MPI_Comm_get_name -  Get the name associated with a communicator
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Comm_get_name(MPI_Comm comm, char *name, int *length)
12

INPUT PARAMETERS

14       comm   - Communicator
15
16

OUTPUT PARAMETERS

18       name   - Name of the communicator
19       length - Integer length of the resulting name
20
21

NOTES

23       This  function  returns  the name of a communicator that was previously
24       set with MPI_Comm_set_name .  If a name was not  previously  associated
25       with  a communicator, the returned string will be empty and length will
26       be 0.  The retuned name will be a maximum of MPI_MAX_OBJECT_NAME  char‐
27       acters long.
28
29

ERRORS

31       If an error occurs in an MPI function, the current MPI error handler is
32       called to handle it.  By default, this error  handler  aborts  the  MPI
33       job.   The  error  handler may be changed with MPI_Errhandler_set ; the
34       predefined error handler MPI_ERRORS_RETURN may be used to  cause  error
35       values  to  be  returned  (in C and Fortran; this error handler is less
36       useful in with the C++ MPI  bindings.   The  predefined  error  handler
37       MPI::ERRORS_THROW_EXCEPTIONS  should  be used in C++ if the error value
38       needs to be recovered).  Note that MPI does not guarantee that  an  MPI
39       program can continue past an error.
40
41       All  MPI  routines  (except  MPI_Wtime  and MPI_Wtick ) return an error
42       value; C routines as the value of the function and Fortran routines  in
43       the  last  argument.  The C++ bindings for MPI do not return error val‐
44       ues; instead, error values are communicated by throwing  exceptions  of
45       type  MPI::Exception  (but not by default).  Exceptions are only thrown
46       if the error value is not MPI::SUCCESS .
47
48
49       Note that if the MPI::ERRORS_RETURN handler is set in  C++,  while  MPI
50       functions  will  return  upon an error, there will be no way to recover
51       what the actual error value was.
52       MPI_SUCCESS
53              - No error; MPI routine completed successfully.
54       MPI_ERR_COMM
55              - Invalid communicator.  A common error is to use a null  commu‐
56              nicator in a call (not even allowed in MPI_Comm_rank ).
57       MPI_ERR_ARG
58              - Invalid argument.  Some argument is invalid and is not identi‐
59              fied by a specific  error  class.   This  is  typically  a  NULL
60              pointer or other such error.
61
62

MORE INFORMATION

69       For more information, please see the official MPI Forum web site, which
70       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
71       ments contain detailed information about each  MPI  function  (most  of
72       which is not duplicated in these man pages).
73
74       http://www.mpi-forum.org/
75

LOCATION

77       cgetname.c
78
79
80
81LAM/MPI 7.1.2                      2/23/2006              MPI_Comm_get_name(3)