NAME

MPI_Test_cancelled - Tests if a request was cancelled

SYNOPSIS

#include <mpi.h> 
int MPI_Test_cancelled(MPI_Status *status , int *flag ); 
#include <pmpi.h> 
int PMPI_Test_cancelled(MPI_Status *status , int *flag ); 

INPUT PARAMETER

status - request status (structure)

OUTPUT PARAMETER

flag - was the request cancelled? (boolean).

DESCRIPTION

The MPI_Test_cancelled() function is used to determine whether or not a request was cancelled. The status of a request has this information stored in the MPI_ERROR field of the MPI_Status structure. If this value is MPI_ERR_CANCEL then this function will set flag to one. Otherwise, flag will be set to zero.

PMPI_Test_cancelled() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

MPI_SUCCESS - No error;

MPI_ERR_ARG - Invalid pointer.

SEE ALSO

MPI_Test (3) MPI_Wait (3) MPI_Cancel (3) MPI_Get_count (3) MPI_Get_elements (3)

• Lockless
• MPI Documentation
• MPI_Test_cancelled