MPI_Type_get_name function

  • Article

Get the print name for a datatype.

Syntax

int MPIAPI MPI_Type_get_name(
        MPI_Datatype                                                type,
        _Out_z_cap_post_count_(MPI_MAX_OBJECT_NAME,*resultlen) char *type_name,
  _Out_ int                                                         *resultlen
);

Parameters

  • type
    Datatype whose name is to be returned.

  • type_name
    The name previously stored on the datatype, or a empty string if no such name exists.

  • resultlen [out]
    Length of returned 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_TYPE_GET_NAME(DATATYPE, TYPE_NAME, RESULTLEN, IERROR)
        INTEGER DATATYPE, RESULTLEN, IERROR
        CHARACTER*(*) TYPE_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