mpi-finalize-function.md

title	TOCTitle	ms:assetid	ms:mtpsurl	ms:contentKeyID	ms.date	mtps_version	f1_keywords	dev_langs	api_location	api_name	api_type	product	topic_type	product_family_name	ROBOTS	description
MPI_Finalize function	MPI_Finalize function	e93c2023-9526-466a-892d-f11d18bb9bfe	https://msdn.microsoft.com/en-us/library/Dn473372(v=VS.85)	59360908	03/28/2018	v=VS.85	MPI_FINALIZE mpif/MPI_Finalize mpi/MPI_FINALIZE	C++ C	Msmpi.dll	MPI_Finalize	DLLExport	Windows	apiref kbSyntax	VS	INDEX,FOLLOW	Learn about the MPI_Finalize function on Microsoft's platform. Understand its syntax, parameters, return value, and how it impacts MPI processes.

MPI_Finalize function

Terminates the calling MPI process’s execution environment.

Syntax

int MPIAPI MPI_Finalize(void);

Parameters

This function has no parameters.

Return value

MPI_SUCCESS if the function returns successfully. Other error codes if the call failed for other reasons (such as invalid arguments). In Fortran the return value is stored in the IERROR parameter.

Fortran

    MPI_FINALIZE(IERROR)
        INTEGER IERROR

Remarks

All MPI Processes must call this routine before exiting on the thread that called MPI_Init or MPI_Init_thread.

The MPI_Finalize function cleans up all state related to MPI. Once it is called, no other MPI functions may be called, including MPI_Init and MPI_Init_thread. The application must ensure that all pending communications are completed or canceled before calling MPI_Finalize.

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 Management Functions

MPI_Init

MPI_Init_thread