Skip to content

Latest commit

 

History

History
93 lines (64 loc) · 2.37 KB

MPI_Session_get_nth_pset.3.rst

File metadata and controls

93 lines (64 loc) · 2.37 KB
Raw

MPI_Session_get_nth_pset

:ref:`MPI_Session_get_nth_pset` - Query runtime for name of the nth process set

SYNTAX

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)

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

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

INPUT PARAMETERS

  • session : session (handle)
  • info : info object (handle)
  • n : index of the desired process set name (integer)

INPUT/OUTPUT PARAMETER

  • pset_len : length of the pset_name argument (integer)

OUTPUT PARAMETERS

  • pset_name : name of the nth process set (string)
  • ierror : Fortran only: Error status (integer).

DESCRIPTION

:ref:`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.

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.

ERRORS

.. seealso:: :ref:`MPI_Session_init`