PMI_Get_base_rank_in_app

PMI_Get_base_rank_in_app - Returns the base rank of the application within the process group

SYNOPSIS

C or C++ SYNOPSIS

#include <pmi.h>
int PMI_Get_base_rank_in_app(int appnum, int *rank);

IMPLEMENTATION

Cray Linux Environment (CLE)

DESCRIPTION

Returns the base rank of the application within the process group to which a process belongs. For an SPMD process group, this rank will always be 0. The argument appnum is an integer associated with the index of the list of applications supplied to the job launcher. This function replaces the deprecated PMI_CRAY_Get_base_rank_in_app() function.

appnum

An integer associated with the index of the list of applications supplied to the job launcher.

rank

Pointer to an integer that receives the rank in the process group.

RETURN VALUES

PMI_SUCCESS

Operation completed successfully

PMI_FAIL

Operation failed

PMI_ERR_INIT

PMI not initialized

PMI_ERR_INVALID_ARG

Invalid argument