Edit

Share via

MPI_Comm_free_keyval function

  • Article

Frees an extant attribute key.

Syntax

int MPIAPI MPI_Comm_free_keyval(
   _Inout_ int *comm_keyval
);

Parameters

  • comm_keyval
    Key value.

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_FREE_KEYVAL(COMM_KEYVAL, IERROR)
        INTEGER COMM_KEYVAL, IERROR

Remarks

This function sets the value of keyval to MPI_KEYVAL_INVALID. Note that it is not erroneous to free an attribute key that is in use, because the actual free does not transpire until after all references (in other communicators on the process) to the key have been freed. These references need to be explictly freed by the program, either via calls to MPI_Comm_delete_attr that free one attribute instance, or by calls to MPI_Comm_free that free all attribute instances associated with the freed communicator.

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