MPICommgetname(3OpenMPI) MPICommgetname(3OpenMPI)

NAME
       MMPPIICCoommmmggeettnnaammee  - Returns the name that was most recently associated
       with a communicator.


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


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


CC++++ SSyynnttaaxx
       #include 
       void MPI::Comm::Getname(char* commname, int& resultlen) const


IINNPPUUTT PPAARRAAMMEETTEERR
       comm      Communicator the name of which is to be returned (handle).



       OOUUTTPPUUTT PPAARRAAMMEETTEERR

       commname Name previously stored  on  the  communicator,  or  an  empty
                 string if no such name exists (string).

       resultlen Length of returned name (integer).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       MPICommgetname  returns the last name that was previously associated
       with the given communicator. The name may be set and retrieved from any
       language.  The  same  name will be returned independent of the language
       used. commname should be allocated so that it  can  hold  a  resulting
       string  of  length  MPIMAXOBJECTNAME  characters.  MPICommgetname
       returns a copy of the set name in commname.

       If the user has not associated a name with a communicator, or an  error
       occurs,  MPICommgetname  will  return an empty string (all spaces in
       Fortran, "" in C and C++). The three predefined communicators will have
       predefined   names   associated   with   them.   Thus,   the  names  of
       MPICOMMWORLD,  MPICOMMSELF,  and  MPICOMMPARENT  will  have   the
       default of MPICOMMWORLD, MPICOMMSELF, and MPICOMMPARENT. The fact
       that the system may have chosen to give a default name to a  communica-
       tor  does not prevent the user from setting a name on the same communi-
       cator; doing this removes the old name and assigns the new one.


NNOOTTEESS
       It is safe simply to print the string returned by MPICommgetname, as
       it is always a valid string even if there was no name.

       Note  that  associating a name with a communicator has no effect on the
       semantics of an MPI program, and will (necessarily) increase the  store
       requirement  of  the program, since the names must be saved. Therefore,
       there is no requirement that users use  these  functions  to  associate
       names  with communicators. However debugging and profiling MPI applica-
       tions may be made easier if names are  associated  with  communicators,
       since  the debugger or profiler should then be able to present informa-
       tion in a less cryptic manner.


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.




Open MPI 1.2                    September 2006     MPICommgetname(3OpenMPI)