17.2.325. MPI_Session_get_pset_info

MPI_Session_get_pset_info - Returns an info object containing properties of a specific process set

17.2.325.1. Syntax

17.2.325.1.1. C Syntax

#include <mpi.h>

int MPI_Session_get_pset_info(MPI_Session session, const char *pset_name, MPI_Info *info)

17.2.325.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_SESSION_GET_PSET_INFO(SESSION, PSET_NAME, INFO, IERROR)
    INTEGER SESSION, INFO, IERROR
    CHARACTER*(*) PSET_NAME

17.2.325.1.3. Fortran 2008 Syntax

USE mpi_f08

MPI_Session_get_pset_info(session, pset_name, info, ierror)
    TYPE(MPI_Session), INTENT(IN) :: session
    CHARACTER(LEN=*), INTENT(IN) :: pset_name
    TYPE(MPI_Info), INTENT(OUT) :: info
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.325.2. Input Parameters

  • session : session (handle)

  • pset_name : name of process set (string)

17.2.325.3. Output Parameters

  • info: info object (handle)

  • IERROR : Fortran only: Error status (integer).

17.2.325.4. Description

MPI_Session_get_pset_info is used to query properties of a specific process set. The returned info object can be queried with existing MPI info object query functions. One key/value pair must be defined, “mpi_size”. The value of the “mpi_size” key specifies the number of MPI processes in the process set.

17.2.325.5. Notes

The user is responsible for freeing the returned info object via MPI_Info_free.

17.2.325.6. Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Session_set_errhandler; the predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error.

See also

MPI_Session_init