This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

MPI_Type_get_attr(3OpenMPI)                                                      MPI_Type_get_attr(3OpenMPI)



NAME
       MPI_Type_get_attr - Returns the attribute associated with a data type.


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Type_get_attr(MPI_Datatype type, int type_keyval, void *attribute_val, int *flag)


Fortran Syntax (see FORTRAN 77 NOTES)
       INCLUDE 'mpif.h'
       MPI_TYPE_GET_ATTR(TYPE, TYPE_KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR)
            INTEGER   TYPE, TYPE_KEYVAL, IERROR
            INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL
            LOGICAL FLAG


C++ Syntax
       #include <mpi.h>
       bool MPI::Datatype::Get_attr(int type_keyval, void* attribute_val) const


INPUT PARAMETERS
       type      Data type to which the attribute is attached (handle).

       type_keyval
                 Key value (integer).


OUTPUT PARAMETERS
       attribute_val
                 Attribute value, unless flag = false

       flag      "false" if no attribute is associated with the key (logical).

       IERROR    Fortran only: Error status (integer).


DESCRIPTION
       For  the given data type, MPI_Type_get_attr returns an attribute value that corresponds to the speci-fied specified
       fied key value.


FORTRAN 77 NOTES
       The MPI standard prescribes portable Fortran syntax for the ATTRIBUTE_VAL argument only  for  Fortran
       90.  Sun FORTRAN 77 users may use the non-portable syntax

            INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL

       where  MPI_ADDRESS_KIND  is a constant defined in mpif.h and gives the length of the declared integer
       in bytes.


ERRORS
       Almost all MPI routines return an error value; C routines as the value of the  function  and  Fortran
       routines  in  the  last argument. C++ functions do not return errors. If the default error handler is
       set to MPI::ERRORS_THROW_EXCEPTIONS, 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
       MPI_Comm_set_errhandler;  the  predefined  error handler MPI_ERRORS_RETURN 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
       MPI_Type_set_attr



Open MPI 1.2                                   September 2006                    MPI_Type_get_attr(3OpenMPI)