17.2.301. MPI_Request_get_status

MPI_Request_get_status - Access information associated with a request without freeing the request.

17.2.301.1. SYNTAX

17.2.301.1.1. C Syntax

#include <mpi.h>

int MPI_Request_get_status(MPI_Request request, int *flag, MPI_Status *status)

17.2.301.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_REQUEST_GET_STATUS(REQUEST, FLAG, STATUS, IERROR)
     INTEGER REQUEST, STATUS(MPI_STATUS_SIZE), IERROR
     LOGICAL FLAG

17.2.301.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Request_get_status(request, flag, status, ierror)
     TYPE(MPI_Request), INTENT(IN) :: request
     LOGICAL, INTENT(OUT) :: flag
     TYPE(MPI_Status) :: status
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.301.2. INPUT PARAMETER

  • request: Communication request (handle).

17.2.301.3. OUTPUT PARAMETERS

  • flag: Boolean flag, same as from MPI_Test (logical).

  • status: MPI_Status object if flag is true (status).

17.2.301.4. DESCRIPTION

MPI_Request_get_status sets flag=true if the operation is complete or sets flag=false if it is not complete. If the operation is complete, it returns in status the request status. It does not deallocate or deactivate the request; a subsequent call to test, wait, or free should be executed with that request.

If your application does not need to examine the status field, you can save resources by using the predefined constant MPI_STATUS_IGNORE as a special value for the status argument.

17.2.301.5. 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_Comm_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.