MPI_Test_cancelled function

Tests to see if a request was cancelled.

Syntax

int MPIAPI MPI_Test_cancelled(
  _In_  MPI_Status *status,
  _Out_ int        *flag
);

Parameters

• status [in]
  Status object.

• flag [out]
  True if the request was cancelled, false otherwise.

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

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