MPITypegetenvelope(3OpenMPI) MPITypegetenvelope(3OpenMPI)

NAME
       MMPPIITTyyppeeggeetteennvveellooppee  - Returns informaion about input arguments asso-
       ciated with a data type.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPITypegetenvelope(MPIDatatype datatype, int *numintegers,
            int *numaddresses, int *numdatatypes, int *combiner)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPITYPEGETENVELOPE(DATATYPE, NUMINTEGERS, NUMADDRESSES,
                 NUMDATATYPES, COMBINER, IERROR)
            INTEGER   DATATYPE, NUMINTEGERS, NUMADDRESSES
            INTEGER   NUMDATATYPES, COMBINER, IERROR


CC++++ SSyynnttaaxx
       #include 
       void MPI::Datatype::Getenvelope(int& numintegers,
            int& numaddresses, int& numdatatypes,
            int& combiner) const


IINNPPUUTT PPAARRAAMMEETTEERR
       datatype  Data type to access (handle).


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       numintegers
                 Number of input integers used in the call  constructing  com-
                 biner (nonnegative integer).

       numaddresses
                 Number  of input addresses used in the call constructing com-
                 biner (nonnegative integer).

       numdatatypes
                 Number of input data types used in the call constructing com-
                 biner (nonnegative integer).

       combiner  Combiner (state).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       For  the  given data type, MPITypegetenvelope returns information on
       the number and type of input arguments used in teh  call  that  created
       the  data  type. The number-of-arguments values returned can be used to
       provide   sufficiently   large   arrays   in   the   decoding   routine
       MPITypegetcontents. This call and the meaning of the returned values
       is described below. The combiner reflects the MPI data type constructor
       call that was used in creating datatype.


NNOOTTEESS
       These are the values that can be returned in combiner and their associ-
       ated calls:

       Values                          Associated Calls

       MPICOMBINERNAMED              a named predefined data type
       MPICOMBINERDUP                MPITypedup
       MPICOMBINERCONTIGUOUS         MPITypecontiguous
       MPICOMBINERVECTOR             MPITypevector
       MPICOMBINERHVECTORINTEGER    MPITypehvector from Fortran
       MPICOMBINERHVECTOR            MPITypehvector from C or C++
                                         and MPITypecreate for
                                         all languages
       MPICOMBINERINDEXED            MPITypeindexed
       MPICOMBINERHINDEXEDINTEGER   MPITypehindexed from Fortran
       MPICOMBINERHINDEXED           MPITypehindexed from C or C++
                                         and MPITypecreatehindexed
                                         for all languages
       MPICOMBINERINDEXEDBLOCK      MPITypecreateindexedblock
       MPICOMBINERSTRUCTINTEGER     MPITypestruct from Fortran
       MPICOMBINERSTRUCT             MPITypestruct from C or C++
                                         and MPITypecreatestruct
                                         for all languages
       MPICOMBINERSUBARRAY           MPITypecreatesubarray
       MPICOMBINERDARRAY             MPITypecreatedarray
       MPICOMBINERF90REAL           MPITypecreatef90real
       MPICOMBINERF90COMPLEX        MPITypecreatef90complex
       MPICOMBINERF90INTEGER        MPITypecreatef90integer
       MPICOMBINERRESIZED            MPITypecreateresized

       If combiner is MPICOMBINERNAMED, then datatype is a named  predefined
       data type.

       The  actual  arguments used in the creation call for a data type can be
       obtained from the call MPITypegetcontents.


EERRRROORRSS
       Almost all MPI routines return an error value; C routines as the  value
       of  the  function  and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default  error  handler  is  set  to
       MPI::ERRORSTHROWEXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI  error  handler  is
       called.  By  default, this error handler aborts the MPI job, except for
       I/O  function  errors.  The  error  handler   may   be   changed   with
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       may be used to cause error values to be returned. Note  that  MPI  does
       not guarantee that an MPI program can continue past an error.


SEE ALSO
       MPITypegetcontents




Open MPI 1.2                    September 2006 MPITypegetenvelope(3OpenMPI)