MPI\_SESSION\_GET\_PSET\_INFO(3) Open MPI MPI\_SESSION\_GET\_PSET\_INFO(3)

MPI\_Session\_get\_pset\_info — Returns an info object containing properties of a specific process set

# [SYNTAX](#SYNTAX)

## [C Syntax](#C_Syntax)

```
#include <mpi.h>
int MPI_Session_get_pset_info(MPI_Session session, const char *pset_name, MPI_Info *info)
```

## [Fortran Syntax](#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
```

## [Fortran 2008 Syntax](#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
```

# [INPUT PARAMETERS](#INPUT_PARAMETERS)

- **session** : session (handle)
- **pset\_name** : name of process set (string)

# [OUTPUT PARAMETERS](#OUTPUT_PARAMETERS)

- **info** : info object (handle)
- **ierror** : Fortran only: Error status (integer).

# [DESCRIPTION](#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.

# [NOTES](#NOTES)

The user is responsible for freeing the returned info object via MPI\_Info\_free &lt;#mpi-info-free&gt;.

# [ERRORS](#ERRORS)

Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI\_COMM\_SELF and will call the associated MPI error handler. When MPI\_COMM\_SELF is not initialized (i.e., before MPI\_Init &lt;#mpi-init&gt;/MPI\_Init\_thread &lt;#mpi-init-thread&gt;, after MPI\_Finalize &lt;#mpi-finalize&gt;, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI\_Comm\_set\_errhandler &lt;#mpi-comm-set-errhandler&gt; on MPI\_COMM\_SELF when using the World model, or the mpi\_initial\_errhandler CLI argument to mpiexec or info key to MPI\_Comm\_spawn &lt;#mpi-comm-spawn&gt;/MPI\_Comm\_spawn\_multiple &lt;#mpi-comm-spawn-multiple&gt;. If no other appropriate error handler has been set, then the MPI\_ERRORS\_RETURN error handler is called for MPI I/O functions and the MPI\_ERRORS\_ABORT error handler is called for all other MPI functions.

Open MPI includes three predefined error handlers that can be used:

- **MPI\_ERRORS\_ARE\_FATAL** Causes the program to abort all connected MPI processes.
- **MPI\_ERRORS\_ABORT** An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if MPI\_Abort &lt;#mpi-abort&gt; was called on that communicator. If called on a window or file, acts as if MPI\_Abort &lt;#mpi-abort&gt; was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.
- **MPI\_ERRORS\_RETURN** Returns an error code to the application.

MPI applications can also implement their own error handlers by calling:

- MPI\_Comm\_create\_errhandler &lt;#mpi-comm-create-errhandler&gt; then MPI\_Comm\_set\_errhandler &lt;#mpi-comm-set-errhandler&gt;
- MPI\_File\_create\_errhandler &lt;#mpi-file-create-errhandler&gt; then MPI\_File\_set\_errhandler &lt;#mpi-file-set-errhandler&gt;
- MPI\_Session\_create\_errhandler &lt;#mpi-session-create-errhandler&gt; then MPI\_Session\_set\_errhandler &lt;#mpi-session-set-errhandler&gt; or at MPI\_Session\_init &lt;#mpi-session-init&gt;
- MPI\_Win\_create\_errhandler &lt;#mpi-win-create-errhandler&gt; then MPI\_Win\_set\_errhandler &lt;#mpi-win-set-errhandler&gt;

Note that MPI does not guarantee that an MPI program can continue past an error.

See the MPI man page &lt;#open-mpi&gt; for a full list of MPI error codes &lt;#open-mpi-errors&gt;.

See the Error Handling section of the MPI-3.1 standard for more information.

**See also:**

MPI\_Session\_init &lt;#mpi-session-init&gt;

# [Copyright](#Copyright)

2003-2026, The Open MPI Community

September 17, 2026

---

Document: MPI_Session_get_pset_info(3) from openmpi-cuda-13.4 5.0.11-r0 (Chainguard OS)