<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MPI_Comm_get_name</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1 id="MPI_Comm_get_name">MPI_Comm_get_name</H1>
Return the print name from the communicator
<H2>Synopsis</H2>
<PRE>
int MPI_Comm_get_name(MPI_Comm comm, char *comm_name, int *resultlen)
</PRE>
<H2>Input Parameters</H2>
<DL>
<DT><B>comm </B> <DD> Communicator to get name of (handle)
</DL>
<P>
<H2>Output Parameters</H2>
<DL>
<DT><B>comm_name </B> <DD> On output, contains the name of the communicator. It must
be an array of size at least <tt>MPI_MAX_OBJECT_NAME</tt>.
<DT><B>resultlen </B> <DD> Number of characters in name
</DL>
<P>
<H2>Notes</H2>
<P>
Because MPI specifies that null objects (e.g., <tt>MPI_COMM_NULL</tt>) are invalid
as input to MPI routines unless otherwise specified, using <tt>MPI_COMM_NULL
</tt>as input to this routine is an error.
<P>
<P>
<H2>Thread and Interrupt Safety</H2>
<P>
This routine is thread and interrupt safe only if no MPI routine that
updates or frees the same MPI object may be called concurrently
with this routine.
<P>
The MPI standard defined a thread-safe interface but this does not
mean that all routines may be called without any thread locks. For
example, two threads must not attempt to change the contents of the
same <tt>MPI_Info</tt> object concurrently. The user is responsible in this
case for using some mechanism, such as thread locks, to ensure that
only one thread at a time makes use of this routine.
<P>
<P>
<H2>Notes for Fortran</H2>
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
</tt>is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
<tt>call</tt> statement.
<P>
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
</tt>in Fortran.
<P>
<H2>Errors</H2>
<P>
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
its use is deprecated. The predefined error handler
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Note that MPI does <em>not</em> guarentee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
<P>
<DL>
<DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
</DL>
<DL>
<DT><B>MPI_ERR_COMM </B> <DD> Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in <tt>MPI_Comm_rank</tt>).
</DL>
</BODY></HTML>