MPIErrorstring(3OpenMPI) MPIErrorstring(3OpenMPI)

NAME
       MMPPIIEErrrroorrssttrriinngg  - Returns a string for a given error code.


SSYYNNTTAAXX
CC SSyynnttaaxx
       #include 
       int MPIErrorstring(int errorcode, char *string, int *resultlen)


FFoorrttrraann SSyynnttaaxx
       INCLUDE 'mpif.h'
       MPIERRORSTRING(ERRORCODE, STRING, RESULTLEN, IERROR)
            INTEGER        ERRORCODE, RESULTLEN, IERROR
            CHARACTER*(*)  STRING


CC++++ SSyynnttaaxx
       #include 
       void Geterrorstring(int errorcode, char* name, int& resultlen)


IINNPPUUTT PPAARRAAMMEETTEERR
       errorcode Error  code returned by an MPI routine or an MPI error class.


OOUUTTPPUUTT PPAARRAAMMEETTEERRSS
       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
       MPIMAXERRORSTRING characters long.

       The number of characters actually written is  returned  in  the  output
       argument, resultlen.


EERRRROORRSS
       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::ERRORSTHROWEXCEPTIONS, 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
       MPICommseterrhandler; the predefined error handler MPIERRORSRETURN
       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
       MPIErrorclass





Open MPI 1.2                    September 2006      MPIErrorstring(3OpenMPI)