MPI_Comm_disconnect function

  • Article

Disconnect from a communicator.

Syntax

int MPIAPI MPI_Comm_disconnect(
  _In_ MPI_Comm *comm
);

Parameters

  • comm [in]
    Communicator.

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_COMM_DISCONNECT(COMM, IERROR)
        INTEGER COMM, IERROR

Remarks

This routine waits for all pending communication to complete, then frees the communicator and sets comm to MPI_COMM_NULL. It may not be called with MPI_COMM_WORLD or MPI_COMM_SELF.

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