Edit

Share via

MPI_Type_get_contents function

  • Article

Gets the contents of the type.

Syntax

int MPIAPI MPI_Type_get_contents(
   MPI_Datatype                          datatype,
   int                                   max_integers,
   int                                   max_addresses,
   int                                   max_datatypes,
   _Out_cap_(max_integers) int           array_of_integers[],
   _Out_cap_(max_addresses) MPI_Aint     array_of_addresses[],
   _Out_cap_(max_datatypes) MPI_Datatype array_of_datatypes[]
);

Parameters

  • datatype
    Datatype to access.

  • max_integers
    Number of elements in array_of_integers.

  • max_addresses
    Number of elements in array_of_addresses.

  • max_datatypes
    Number of elements in array_of_datatypes.

  • array_of_integers
    Contains integer arguments used in constructing the datatype.

  • array_of_addresses
    Contains address arguments used in constructing the datatype.

  • array_of_datatypes
    Contains datatype arguments used in constructing the datatype.

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_GET_CONTENTS(DATATYPE, MAX_INTEGERS, MAX_ADDRESSES, MAX_DATATYPES,
                ARRAY_OF_INTEGERS, ARRAY_OF_ADDRESSES, ARRAY_OF_DATATYPES, IERROR)
        INTEGER DATATYPE, MAX_INTEGERS, MAX_ADDRESSES, MAX_DATATYPES,
        ARRAY_OF_INTEGERS(*), ARRAY_OF_DATATYPES(*), IERROR
        INTEGER(KIND=MPI_ADDRESS_KIND) ARRAY_OF_ADDRESSES(*)

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