MPI_Comm_set_name function

Sets the print name for a communicator.

Syntax

int MPIAPI MPI_Comm_set_name(
   MPI_Comm    comm,
   _In_z_ char *comm_name
);

Parameters

• comm
  Communicator to name.

• comm_name
  Name for communicator.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_COMM_SET_NAME(COMM, COMM_NAME, IERROR)
        INTEGER COMM, IERROR
        CHARACTER*(*) COMM_NAME

Requirements

Product	HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities
Header	Mpi.h; Mpif.h
Library	Msmpi.lib
DLL	Msmpi.dll

See also

MPI Miscellaneous Functions