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_Add_error_code(3OpenMPI)                                                    MPI_Add_error_code(3OpenMPI)



NAME
       MPI_Add_error_code - Creates a new error code associated with errorclass


SYNTAX
C Syntax
       #include <mpi.h>
       int MPI_Add_error_code(int errorclass, int *errorcode)


Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_ADD_ERROR_CODE(ERRORCLASS, ERRORCODE, IERROR)
            INTEGER  ERRORCLASS, ERRORCODE, IERROR


C++ Syntax
       #include <mpi.h>
       int MPI::Add_error_code(int errorclass, int* errorcode)


INPUT PARAMETER
       errorclass    MPI error class (integer).


OUTPUT PARAMETERS
       errorcode     Error code returned by an MPI routine or an MPI error class (integer).

       IERROR        Fortran only: Error status (integer).


DESCRIPTION
       Creates a new error code associated with errorclass and returns its value in errorcode.


NOTES
       No  function  is  provided to free error codes, as it is not expected that an application will create
       them in significant numbers.

       The value returned is always greater than or equal to MPI_ERR_LASTCODE.


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_Add_error_class
       MPI_Error_class





Open MPI 1.2                                   September 2006                   MPI_Add_error_code(3OpenMPI)