MPI_ERROR_STRING, MPI_Error_string

Purpose

Returns the error string for a given error code.

C synopsis

#include <mpi.h>
int MPI_Error_string(int errorcode,char *string,
      int *resultlen);

C++ synopsis

#include mpi.h
void MPI::Get_error_string(int errorcode, char* string, int& resultlen);

FORTRAN synopsis

include 'mpif.h' or use mpi
MPI_ERROR_STRING(INTEGER ERRORCODE,CHARCTER STRING(*),
     INTEGER RESULTLEN,INTEGER IERROR)

Parameters

errorcode
     is the error code returned by an MPI routine (IN)

string
     is the error message for the errorcode (OUT)

resultlen
     is the character length of string (OUT)

IERROR
     is the FORTRAN return code. It is always the last argument.

Description

This subroutine returns the error string for a given error code. The
returned string is null terminated with the terminating byte not counted in
resultlen.

Storage for string must be at least MPI_MAX_ERROR_STRING characters long.
The number of characters actually written is returned in resultlen.

This subroutine returns an empty string (all spaces in FORTRAN, "" in C and
C++) for any user-defined error code or error class, unless the the user
provides a string using MPI_ADD_ERROR_STRING.

Errors

Invalid error code
     errorcode is not defined

MPI not initialized

MPI already finalized

Related information

     MPI_ADD_ERROR_STRING
     MPI_ERROR_CLASS