File: MPI_Error_string.3

package info (click to toggle)
mpich 1.1.0-3
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 22,116 kB
  • ctags: 27,349
  • sloc: ansic: 193,435; sh: 11,172; fortran: 6,545; makefile: 5,801; cpp: 5,020; tcl: 3,548; asm: 3,536; csh: 1,079; java: 614; perl: 183; awk: 168; sed: 70; f90: 62
file content (60 lines) | stat: -rw-r--r-- 1,155 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.TH MPI_Error_string 3 "1/6/1997" " " "MPI"
.SH NAME
MPI_Error_string \-  Return a string for a given error code 
.SH SYNOPSIS
.nf
#include "mpi.h"
int MPI_Error_string( errorcode, string, resultlen )
int  errorcode, *resultlen;
char *string;
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B errorcode 
- Error code returned by an MPI routine or an MPI error class
.PD 1

.SH OUTPUT PARAMETER
.PD 0
.TP
.B string 
- Text that corresponds to the errorcode 
.PD 1
.PD 0
.TP
.B resultlen 
- Length of string 
.PD 1

Notes:  Error codes are the values return by MPI routines (in C) or in the
.I ierr
argument (in Fortran).  These can be converted into error classes
with the routine 
.I MPI_Error_class
.

.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for 
.I MPI_WTIME
and 
.I MPI_WTICK
) have
an additional argument 
.I ierr
at the end of the argument list.  
.I 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
.I call
statement.

All MPI objects (e.g., 
.I MPI_Datatype
, 
.I MPI_Comm
) are of type 
.I INTEGER
in Fortran.
.SH LOCATION
errorstring.c