MPI_Comm_get_name function

  • Article

Return the print name from the communicator.

Syntax

int MPIAPI MPI_Comm_get_name(
        MPI_Comm                                                    comm,
        _Out_z_cap_post_count_(MPI_MAX_OBJECT_NAME,*resultlen) char *comm_name,
  _Out_ int                                                         *resultlen
);

Parameters

  • comm
    Communicator to get name of.

  • comm_name
    On output, contains the name of the communicator. It must be an array of size at least MPI_MAX_OBJECT_NAME.

  • resultlen [out]
    Number of characters in name.

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_GET_NAME(COMM, COMM_NAME, RESULTLEN, IERROR)
        INTEGER COMM, RESULTLEN, 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