18.2.321. MPI_Session_get_nth_pset
MPI_Session_get_nth_pset - Query runtime for name of the nth process set
18.2.321.1. Syntax
18.2.321.1.1. C Syntax
#include <mpi.h>
int MPI_Session_get_nth_pset(MPI_Session session, MPI_Info info, int n, int *pset_len, char *pset_name)
18.2.321.1.2. Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_SESSION_GET_NTH_PSET(SESSION, INFO, N, PSET_LEN, PSET_NAME, IERROR)
INTEGER SESSION, INFO, N, PSET_LEN, IERROR
CHARACTER*(*) PSET_NAME
18.2.321.1.3. Fortran 2008 Syntax
USE mpi_f08
MPI_Session_get_nth_pset(session, info, n, pset_len, pset_name, ierror)
TYPE(MPI_Session), INTENT(IN) :: session
TYPE(MPI_Info), INTENT(IN) :: info
INTEGER, INTENT(IN) :: n
INTEGER, INTENT(INOUT) :: pset_len
CHARACTER(LEN=*), INTENT(OUT) :: pset_name
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
18.2.321.2. Input Parameters
session : session (handle)
info: info object (handle)
n: index of the desired process set name (integer)
18.2.321.2.1. Input/Output Parameter
pset_len: length of the pset_name argument (integer)
18.2.321.3. Output Parameters
pset_name : name of the nth process set (string)
IERROR : Fortran only: Error status (integer).
18.2.321.4. Description
MPI_Session_get_nth_pset returns the name of the nth process set in the supplied pset_name buffer. pset_len is the size of the buffer needed to store the nth process set name. If the pset_len passed into the function is less than the actual buffer size needed for the process set name, then the string value returned in pset_name is truncated. If pset_len is set to 0, pset_name is not changed. On return, the value of pset_len will be set to the required buffer size to hold the process set name. In C, pset_len includes the required space for the null terminator. In C, this function returns a null terminated string in all cases where the pset_len input value is greater than 0.
18.2.321.5. Notes
Process set names have an implementation-defined maximum length of MPI_MAX_PSET_NAME_LEN characters. MPI_MAX_PSET_NAME_LEN shall have a value of at least 63.
18.2.321.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