source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Errhandler_set.3 @ 97

Last change on this file since 97 was 97, checked in by (none), 14 years ago

Adding compiled files

File size: 1.9 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\" Copyright (c) 1996 Thinking Machines Corporation
3.TH MPI_Errhandler_set 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Errhandler_set \fP \- Sets the error handler for a communicator -- use of this routine is deprecated.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Errhandler_set(MPI_Comm \fIcomm\fP, MPI_Errhandler \fIerrhandler\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_ERRHANDLER_SET(\fICOMM, ERRHANDLER, IERROR\fP)
18        INTEGER \fICOMM, ERRHANDLER, IERROR\fP
19
20
21.SH INPUT PARAMETERS
22.ft R
23.TP 1i
24comm
25Communicator to set the error handler for (handle).
26.TP 1i
27errhandler
28New MPI error handler for communicator (handle).
29
30.SH OUTPUT PARAMETER
31.ft R
32.TP 1i
33IERROR
34Fortran only: Error status (integer).
35
36.SH DESCRIPTION
37.ft R
38Note that use of this routine is \fIdeprecated\fP as of MPI-2. Please use MPI_Comm_set_errhandler instead.
39.sp
40This deprecated routine is not available in C++.
41.sp
42Associates the new error handler errhandler with communicator comm at the calling process. Note that an error handler is always associated with the communicator.
43
44.SH ERRORS
45Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI::Exception object.
46.sp
47Before the error value is returned, the current MPI error handler is
48called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; the predefined error handler MPI_ERRORS_RETURN 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. 
49
50.SH SEE ALSO
51.ft R
52.sp
53MPI_Comm_create_errhandler
54.br
55MPI_Comm_get_errhandler
56.br
57MPI_Comm_set_errhandler
58
59
Note: See TracBrowser for help on using the repository browser.