MPI_Request_free function
Frees a communication request object.
Syntax
int MPIAPI MPI_Request_free(
_Inout_ MPI_Request *request
);
Parameters
- request
Communication 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_REQUEST_FREE(REQUEST, IERROR)
INTEGER REQUEST, IERROR
Remarks
This routine is normally used to free inactive persistent requests created with either MPI_Recv_init or MPI_Send_init and friends. It is also permissible to free an active request. However, once freed, the request can no longer be used in a wait or test routine (e.g., MPI_Wait) to determine completion.
This routine may also be used to free a non-persistent requests such as those created with MPI_Irecv or MPI_Isend and friends. Like active persistent requests, once freed, the request can no longer be used with test/wait routines to determine completion.
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 |