MPI_Type_create_keyval function

Article
09/14/2018

Creates an attribute keyval for MPI datatypes.

Syntax

int MPIAPI MPI_Type_create_keyval(
  _In_     MPI_Type_copy_attr_function   *type_copy_attr_fn,
  _In_     MPI_Type_delete_attr_function *type_delete_attr_fn,
  _Out_    int                           *type_keyval,
  _In_opt_ void                          *extra_state
);

Parameters

type_copy_attr_fn [in]
Copy callback function for type_keyval.
type_delete_attr_fn [in]
Delete callback function for type_keyval.
type_keyval [out]
Key value for future access.
extra_state [in, optional]
Extra state for callback functions.

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_TYPE_CREATE_KEYVAL(TYPE_COPY_ATTR_FN, TYPE_DELETE_ATTR_FN, TYPE_KEYVAL,
                EXTRA_STATE, IERROR)
        EXTERNAL TYPE_COPY_ATTR_FN, TYPE_DELETE_ATTR_FN
        INTEGER TYPE_KEYVAL, IERROR
        INTEGER(KIND=MPI_ADDRESS_KIND) EXTRA_STATE

Remarks

Default copy and delete functions are available. These are

MPI_TYPE_NULL_COPY_FN - empty copy function
MPI_TYPE_NULL_DELETE_FN - empty delete function
MPI_TYPE_DUP_FN - simple dup function

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