mpi-request-free-function.md

title	TOCTitle	ms:assetid	ms:mtpsurl	ms:contentKeyID	ms.date	mtps_version	f1_keywords	dev_langs	description
MPI_Request_free function	MPI_Request_free function	f89b1d2f-52c1-48e4-8e59-ba7c3f361706	https://msdn.microsoft.com/en-us/library/Dn473460(v=VS.85)	59360995	03/28/2018	v=VS.85	MPI_REQUEST_FREE mpif/MPI_Request_free mpi/MPI_REQUEST_FREE	C++ C	Learn about the MPI_Request_free function, its syntax, parameters, and usage in freeing communication requests in MPI. Perfect for HPC Pack users.

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

See also

MPI Point to Point Functions