MPI_Type_get_envelope function - Message Passing Interface (original) (raw)

Returns information on the number and type of input arguments used in the call that created the datatype.

Syntax

int MPIAPI MPI_Type_get_envelope(
        MPI_Datatype datatype,
  _Out_ int          *num_integers,
  _Out_ int          *num_addresses,
  _Out_ int          *num_datatypes,
  _Out_ int          *combiner
);

Parameters

datatype
Datatype to access.
num_integers [out]
Number of input integers used in the call constructing combiner.
num_addresses [out]
Number of input addresses used in the call constructing combiner.
num_datatypes [out]
Number of input datatypes used in the call constructing combiner.
combiner [out]
Combiner.

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_ENVELOPE(DATATYPE, NUM_INTEGERS, NUM_ADDRESSES, NUM_DATATYPES,
                COMBINER, IERROR)
        INTEGER DATATYPE, NUM_INTEGERS, NUM_ADDRESSES, NUM_DATATYPES, COMBINER,
        IERROR

Requirements