MPICommsetname(3OpenMPI) MPICommsetname(3OpenMPI)

NAME
       MMPPIICCoommmmsseettnnaammee - Associates a name with a communicator.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPICommsetname(MPIComm comm, char *commname)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPICOMMSETNAME(COMM, COMMNAME, IERROR)
            INTEGER   COMM, IERROR
            CHARACTER*(*) COMMNAME


CC++++ SSyynnttaaxx
       #include 
       void MPI::Comm::Setname(const char* commname)


IINNPPUUTT//OOUUTTPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator whose identifier is to be set (handle).


IINNPPUUTT PPAARRAAMMEETTEERR
       commname Character  string to be used as the identifier for the commu-
                 nicator (string).


OOUUTTPPUUTT PPAARRAAMMEETTEERR
       IERROR    Fortran only: Error status (integer).



DESCRIPTION
       MPICommsetname allows a user to associate a name string with a  com-
       municator.  The character string that is passed to MPICommsetname is
       saved inside the MPI library (so it can be freed by the caller  immedi-
       ately  after  the  call,  or allocated on the stack). Leading spaces in
       name are significant, but trailing ones are not.

       MPICommsetname is a local (noncollective) operation,  which  affects
       only  the name of the communicator as seen in the process that made the
       MPICommsetname call. There is no requirement that the same (or  any)
       name be assigned to a communicator in every process where it exists.

       The  length  of  the name that can be stored is limited to the value of
       MPIMAXOBJECTNAME in Fortran and MPIMAXOBJECTNAME-1 in C  and  C++
       (to  allow  for the null terminator). Attempts to set names longer than
       this will result in truncation of the  name.  MPIMAXOBJECTNAME  must
       have a value of at least 64.



NNOOTTEESS
       Since  MPICommsetname is provided to help debug code, it is sensible
       to give the same name to a communicator in all of the  processes  where
       it exists, to avoid confusion.

       Regarding  name  length,  under  circumstances  of store exhaustion, an
       attempt to set a name of any length could fail; therefore, the value of
       MPIMAXOBJECTNAME  should  be  viewed only as a strict upper bound on
       the name length, not a guarantee that setting names of less  than  this
       length will always succeed.


EERRRROORRSS
       Almost  all MPI routines return an error value; C routines as the value
       of the function and Fortran routines in the last  argument.  C++  func-
       tions  do  not  return  errors.  If the default error handler is set to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before  the  error  value is returned, the current MPI error handler is
       called. By default, this error handler aborts the MPI job,  except  for
       I/O   function   errors.   The   error  handler  may  be  changed  with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       may  be  used  to cause error values to be returned. Note that MPI does
       not guarantee that an MPI program can continue past an error.


SEE ALSO
       MPICommgetname






Open MPI 1.2                    September 2006     MPICommsetname(3OpenMPI)