MPI_Comm_get_name(3)

NAME
MPI_Comm_get_name - Gets the name of the communicator

SYNOPSIS
#include <mpi.h>
int MPI_Comm_get_name(MPI_Comm comm, char *name, int *len);

#include <pmpi.h>
int PMPI_Comm_get_name(MPI_Comm comm, char *name, int *len);

#include <mpi.h>
void MPI::Comm::Get_name(char *name, int &len) const;

INCLUDE 'mpif.h'
MPI_COMM_GET_NAME(comm, name, len, ierr)
CHARACTER*(*) name
INTEGER comm, len, ierr

INPUT PARAMETER
comm
    - communicator (handle)

OUTPUT PARAMETERS
name
    - new name of communicator (string)
len - length of the name string (integer)

DESCRIPTION
The MPI_Comm_get_name() function is used to get a name assigned to a communicator. This may be useful for error reporting. This name may be stored through the use of the MPI_Comm_set_name() function. The name will be smaller than MPI_MAX_OBJECT_NAME in size, allowing a buffer of that size to be passed into this function. The length of the name is returned in len minus the trailing '\0'. The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Comm_get_name() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_COMM
    - Invalid communicator;
MPI_ERR_ARG
    - Invalid output pointers.

SEE ALSO
MPI_Comm_set_name(3), MPI_Comm_create(3), MPI_Comm_free(3), MPI_Intercomm_create(3),