Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 1.68 KB

MPI_Add_error_string.3.rst

File metadata and controls

79 lines (51 loc) · 1.68 KB
Raw

MPI_Add_error_string

:ref:`MPI_Add_error_string` |mdash| Associates a string with an error code or class

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Add_error_string(int errorcode, const char *string)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ADD_ERROR_STRING(ERRORCODE, STRING, IERROR)
     INTEGER         ERRORCODE, IERROR
     CHARACTER*(*)   STRING

Fortran 2008 Syntax

USE mpi_f08
MPI_Add_error_string(errorcode, string, ierror)
     INTEGER, INTENT(IN) :: errorcode
     CHARACTER(LEN=*), INTENT(IN) :: string
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

INPUT PARAMETERS

  • errorcode: MPI error class, or an error code returned by an MPI routine (integer).
  • string: Text that corresponds to the error code or class (string).

OUTPUT PARAMETER

  • ierror: Fortran only: Error status (integer).

DESCRIPTION

This routine associates an error string with an error code or class. Calling :ref:`MPI_Add_error_string` for an error code or class that already has an associated error string will replace the old string with the new one. It is erroneous to call :ref:`MPI_Add_error_string` for an error value not generated via :ref:`MPI_Add_error_class` or :ref:`MPI_Add_error_code` (e.g., an error code or class with a value not greater than MPI_LAST_ERRCODE).

ERRORS

.. seealso::
   * :ref:`MPI_Add_error_class`
   * :ref:`MPI_Add_error_code`
   * :ref:`MPI_Error_class`
   * :ref:`MPI_Error_string`