mpi-request-get-status-function.md

title	TOCTitle	ms:assetid	ms:mtpsurl	ms:contentKeyID	ms.date	mtps_version	f1_keywords	dev_langs	description
MPI_Request_get_status function	MPI_Request_get_status function	31c598c3-0b5e-4509-9357-93c6d4f20bdd	https://msdn.microsoft.com/en-us/library/Dn473461(v=VS.85)	59360996	03/28/2018	v=VS.85	MPI_REQUEST_GET_STATUS mpif/MPI_Request_get_status mpi/MPI_REQUEST_GET_STATUS	C++ C	Learn about MPI_Request_get_status function on Microsoft's site. Understand its syntax, parameters, return value, and how it differs from MPI_Test.

MPI_Request_get_status function

Nondestructive test for the completion of a request.

Syntax

int MPIAPI MPI_Request_get_status(
        MPI_Request request,
  _Out_ int         *flag,
  _Out_ MPI_Status  *status
);

Parameters

• request
  Communication request.

• flag [out]
  True if operation has completed.

• status [out]
  Status object, or MPI_STATUS_IGNORE.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

In Fortran, the return value is stored in the IERROR parameter.

Fortran

    MPI_REQUEST_GET_STATUS( REQUEST, FLAG, STATUS, IERROR)
        INTEGER REQUEST, STATUS(MPI_STATUS_SIZE), IERROR
        LOGICAL FLAG

Remarks

Unlike MPI_Test, MPI_Request_get_status does not deallocate or deactivate the request. A call to one of the test/wait routines or MPI_Request_free should be made to release the request object.

Requirements

Product	HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities
Header	Mpi.h; Mpif.h
Library	Msmpi.lib
DLL	Msmpi.dll

See also

MPI Point to Point Functions