Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_attr_get(3openmpi) [osx man page]

MPI_Attr_get(3OpenMPI)													    MPI_Attr_get(3OpenMPI)

NAME
MPI_Attr_get - Retrieves attribute value by key -- use of this routine is deprecated. SYNTAX
C Syntax #include <mpi.h> int MPI_Attr_get(MPI_Comm comm, int keyval,void *attribute_val, int *flag ) Fortran Syntax INCLUDE 'mpif.h' MPI_ATTR_GET(COMM, KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR) INTEGER COMM, KEYVAL, ATTRIBUTE_VAL, IERROR LOGICAL FLAG INPUT PARAMETERS
comm Communicator to which attribute is attached (handle). keyval Key value (integer). OUTPUT PARAMETERS
attribute_val Attribute value, unless flag = false. flag True if an attribute value was extracted; false if no attribute is associated with the key. IERROR Fortran only: Error status (integer). DESCRIPTION
Note that use of this routine is deprecated as of MPI-2. Please use MPI_Comm_get_attr instead. This deprecated routine is not available in C++. Retrieves attribute value by key. The call is erroneous if there is no key with value keyval. On the other hand, the call is correct if the key value exists, but no attribute is attached on comm for that key; in such case, the call returns flag = false. In particular MPI_KEY- VAL_INVALID is an erroneous key value. 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++ func- tions 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_Comm_get_attr Open MPI 1.2 September 2006 MPI_Attr_get(3OpenMPI)

Check Out this Related Man Page

MPI_Comm_get_errhandler(3OpenMPI)										 MPI_Comm_get_errhandler(3OpenMPI)

NAME
MPI_Comm_get_errhandler - Retrieves error handler associated with a communicator. SYNTAX
C Syntax #include <mpi.h> int MPI_Comm_get_errhandler(MPI_Comm comm, MPI_Errhandler *errhandler) Fortran Syntax INCLUDE 'mpif.h' MPI_COMM_GET_ERRHANDLER(COMM, ERRHANDLER, IERROR) INTEGER COMM, ERRHANDLER, IERROR C++ Syntax #include <mpi.h> MPI::Errhandler MPI::Comm::Get_errhandler() const INPUT PARAMETER
comm Communicator (handle). OUTPUT PARAMETERS
errhandler New error handler for communicator (handle). IERROR Fortran only: Error status (integer). DESCRIPTION
MPI_Comm_get_errhandler retrieves the error handler currently associated with a communicator. This call is identical to MPI_Errhandler_get, the use of which is deprecated. 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++ func- tions 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 the MPI man page for a full list of MPI error codes. Open MPI 1.2 September 2006 MPI_Comm_get_errhandler(3OpenMPI)
Man Page