[This is preliminary documentation and is subject to change.]
Creates a new MPI attribute that can be attached to communicators.
See Create<(Of <(T>)>)(AttributeDuplication)
Namespace:
MPIAssembly: MPI (in MPI.dll)
Version: 0.6.0.0 (0.6.0.0)
Syntax
| C# |
|---|
public static int MPI_Keyval_create( Unsafe..::.MPI_Copy_function copy_fn, Unsafe..::.MPI_Delete_function delete_fn, out int keyval, IntPtr extra_state ) |
| Visual Basic (Declaration) |
|---|
Public Shared Function MPI_Keyval_create ( _ copy_fn As Unsafe..::.MPI_Copy_function, _ delete_fn As Unsafe..::.MPI_Delete_function, _ <OutAttribute> ByRef keyval As Integer, _ extra_state As IntPtr _ ) As Integer |
| Visual C++ |
|---|
public: static int MPI_Keyval_create( Unsafe..::.MPI_Copy_function^ copy_fn, Unsafe..::.MPI_Delete_function^ delete_fn, [OutAttribute] int% keyval, IntPtr extra_state ) |
Parameters
- copy_fn
- Type: MPI..::.Unsafe..::.MPI_Copy_function
The function used to copy the attribute when a communicator is duplicated.
- delete_fn
- Type: MPI..::.Unsafe..::.MPI_Delete_function
The function used to delete the attribute when it is removed from a communicator.
- keyval
- Type:
System..::.Int32
%
Will receive a new integer that identifies this attribute.
- extra_state
- Type: System..::.IntPtr
A user-defined pointer that includes extra information to be passed to the copy and delete functions. This pointer can be used to store more information about the attribute itself.