MPI_Comm_copy_attr_function function

Article
09/14/2018

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

Syntax

int MPI_Comm_copy_attr_function(
           MPI_Comm oldcomm,
           int      comm_keyval,
  _In_opt_ void     *extra_state,
  _In_     void     *attribute_val_in,
  _Out_    void     *attribute_val_out,
  _Out_    int      *flag
);

Parameters

oldcomm
Original communicator.
comm_keyval
Key value.
extra_state [in, optional]
Extra state.
attribute_val_in [in]
Source attribute value.
attribute_val_out [out]
Destination attribute value.
flag [out]
If the returned value of flag is 0 or FALSE, then the attribute is deleted in the duplicated communicator. Otherwise (flag = 1 or TRUE), the new attribute value is set to the value returned in attribute_val_out.

Return value

The function returns MPI_SUCCESS on success and an error code on failure.

Fortran

    SUBROUTINE COMM_COPY_ATTR_FUNCTION(OLDCOMM, COMM_KEYVAL, EXTRA_STATE,
                ATTRIBUTE_VAL_IN, ATTRIBUTE_VAL_OUT, FLAG, IERROR)
        INTEGER OLDCOMM, COMM_KEYVAL, IERROR
        INTEGER(KIND=MPI_ADDRESS_KIND) EXTRA_STATE, ATTRIBUTE_VAL_IN,
            ATTRIBUTE_VAL_OUT
        LOGICAL FLAG

Remarks

The comm_copy_attr_fn function is invoked when a communicator is duplicated by MPI_Comm_dup.

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