Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_add_error_code(3openmpi) [osx man page]

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++ 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_Add_error_class MPI_Error_class Open MPI 1.2 September 2006 MPI_Add_error_code(3OpenMPI)

Check Out this Related Man Page

MPI_Error_string(3OpenMPI)												MPI_Error_string(3OpenMPI)

NAME
MPI_Error_string - Returns a string for a given error code. SYNTAX
C Syntax #include <mpi.h> int MPI_Error_string(int errorcode, char *string, int *resultlen) Fortran Syntax INCLUDE 'mpif.h' MPI_ERROR_STRING(ERRORCODE, STRING, RESULTLEN, IERROR) INTEGER ERRORCODE, RESULTLEN, IERROR CHARACTER*(*) STRING C++ Syntax #include <mpi.h> void Get_error_string(int errorcode, char* name, int& resultlen) INPUT PARAMETER
errorcode Error code returned by an MPI routine or an MPI error class. OUTPUT PARAMETERS
string Text that corresponds to the errorcode. resultlen Length of string. IERROR Fortran only: Error status (integer). DESCRIPTION
Returns the error string associated with an error code or class. The argument string must represent storage that is at least MPI_MAX_ERROR_STRING characters long. The number of characters actually written is returned in the output argument, resultlen. 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_Error_class Open MPI 1.2 September 2006 MPI_Error_string(3OpenMPI)
Man Page