MPI_Get_processor_name function

Article
2018-09-14

Gets the name of the processor.

Syntax

int MPIAPI MPI_Get_processor_name(
        _Out_z_cap_post_count_(MPI_MAX_PROCESSOR_NAME,*resultlen) char *name,
  _Out_ int                                                            *resultlen
);

Parameters

name
A unique specifier for the actual (as opposed to virtual) node. This must be an array of size at least MPI_MAX_PROCESSOR_NAME.
resultlen [out]
Length (in characters) of the 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_GET_PROCESSOR_NAME( NAME, RESULTLEN, IERROR)
        CHARACTER*(*) NAME
        INTEGER RESULTLEN,IERROR

Remarks

The name returned should identify a particular piece of hardware; the exact format is implementation defined. This name may or may not be the same as might be returned by 'gethostname', 'uname', or 'sysinfo'.

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

Share via