MPI_Test function

Tests an outstanding operation for completion.

Syntax


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

Parameters

request [in, out]

A pointer to the MPI_Request handle of an outstanding operation.

flag [out]

On return, contains a pointer to an integer that indicates whether the request is completed. A non-zero value indicates that the request is complete.

status [out]

On return, contains a pointer to an MPI_Status object that describes the specified operation if it is complete.

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

Remarks

This function is a local operation. Successful completion does not depend on any operations at other processes.

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 request, then the function returns with the flag parameter set to a non-zero value and with the status parameter empty.

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
MPI_Wait
MPI_Status
MPI_Testany
MPI_Testall
MPI_Testsome

 

 

Show: