NAME

MPI_Comm_set_name - Sets the name of the communicator

SYNOPSIS

#include <mpi.h> 
int MPI_Comm_set_name(MPI_Comm comm , char *name ); 
#include <pmpi.h> 
int PMPI_Comm_set_name(MPI_Comm comm , char *name ); 

INPUT PARAMETERS

comm - communicator (handle)

name - new name of communicator (string)

DESCRIPTION

The MPI_Comm_set_name() function is used to set a user-specified name for a communicator. This may be useful for error reporting later. The name may be retrieved later through the use of the MPI_Comm_get_name() function. The name must be smaller than MPI_MAX_OBJECT_NAME in size. Trailing spaces will be removed from the stored string. The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Comm_set_name() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this 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.

MPI_SUCCESS - No error;

MPI_ERR_COMM - Invalid communicator;

MPI_ERR_ARG - Invalid string.

SEE ALSO

MPI_Comm_get_name (3) MPI_Comm_create (3) MPI_Comm_free (3) MPI_Intercomm_create (3)

• Lockless
• MPI Documentation
• MPI_Comm_set_name