MPI_Comm_delete_attr_function function

Article
09/14/2018

MPI_Comm_delete_attr_function is a placeholder for the application-defined function name.

Syntax

int MPI_Comm_delete_attr_function(
           MPI_Comm comm,
           int      comm_keyval,
  _In_     void     *attribute_val,
  _In_opt_ void     *extra_state
);

Parameters

comm
Communicator.
comm_keyval
Key value.
attribute_val [in]
Pointer to attribute value.
extra_state [in, optional]
Extra state.

Return value

The function returns MPI_SUCCESS on success and an error code on failure (in which case MPI_Comm_free will fail).

Fortran

    SUBROUTINE COMM_DELETE_ATTR_FUNCTION(COMM, COMM_KEYVAL, ATTRIBUTE_VAL,
                EXTRA_STATE, IERROR)
        INTEGER COMM, COMM_KEYVAL, IERROR
        INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL, EXTRA_STATE

Remarks

This function is invoked when a communicator is deleted by MPI_Comm_free or when a call is made explicitly to MPI_Comm_delete_attr.

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

Share via