MPI_Wait function

Article
09/14/2018

Completes an outstanding operation.

Syntax

int MPIAPI MPI_Wait(
  _Inout_ MPI_Request *request,
  _Out_   MPI_Status  *status
);

Parameters

request [in, out]
A pointer to the MPI_Request handle of an outstanding operation.
status [out]
A pointer to an MPI_Status object that describes the specified request.

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_WAIT(REQUEST, STATUS, IERROR)
        INTEGER REQUEST, STATUS(MPI_STATUS_SIZE), IERROR

Remarks

This function is a non-local operation. Successful completion might depend on matching operations at other processes.

This function returns when the operation that is identified by the request parameter is completed.

If the operation that is associated with this request was a persistent communication operation, the persistent request is marked as inactive. Other operations are deallocated, and the request handle is set to MPI_REQUEST_NULL.

If the request parameter points to a value of MPI_REQUEST_NULL or to an inactive persistent communication request, then the function returns an empty status.

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