DragonFly On-Line Manual Pages
MPI_Add_error_string(3) MPI MPI_Add_error_string(3)
MPI_Add_error_string - Associates an error string with an MPI error
code or class
int MPI_Add_error_string(int errorcode, MPICH2_CONST char *string)
- error code or class (integer)
string - text corresponding to errorcode (string)
The string must be no more than MPI_MAX_ERROR_STRING characters long.
The length of the string is as defined in the calling language. The
length of the string does not include the null terminator in C or C++.
Note that the string is const even though the MPI standard does not
specify it that way.
According to the MPI-2 standard, it is erroneous to call
MPI_Add_error_string for an error code or class with a value less than
or equal to MPI_ERR_LASTCODE . Thus, you cannot replace the predefined
error messages with this routine.
THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. However, the routine is not interrupt safe. Typically,
this is due to the use of memory allocation routines such as malloc or
other non-MPICH runtime routines that are themselves not interrupt-
NOTES FOR FORTRAN
All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
an additional argument ierr at the end of the argument list. ierr is
an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with
the call statement.
All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
value; C routines as the value of the function and Fortran routines in
the last argument. Before the value is returned, the current MPI error
handler is called. By default, this error handler aborts the MPI job.
The error handler may be changed with MPI_Comm_set_errhandler (for
communicators), MPI_File_set_errhandler (for files), and
MPI_Win_set_errhandler (for RMA windows). The MPI-1 routine
MPI_Errhandler_set may be used but its use is deprecated. The
predefined error handler MPI_ERRORS_RETURN may be used to cause error
values to be returned. Note that MPI does not guarentee that an MPI
program can continue past an error; however, MPI implementations will
attempt to continue whenever possible.
- No error; MPI routine completed successfully.