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

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

Adding compiled files

File size: 1.5 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\"Copyright (c) 1996 Thinking Machines
3.TH MPI_Type_free_keyval 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Type_free_keyval\fP \- Frees a previously created type key value.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Type_free_keyval(int *\fItype_keyval\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_TYPE_FREE_KEYVAL(\fITYPE_KEYVAL, IERROR\fP)
18        INTEGER \fITYPE_KEYVAL, IERROR \fP
19
20.SH C++ Syntax
21.nf
22#include <mpi.h>
23static void MPI::Datatype::Free_keyval(int& \fItype_keyval\fP)
24
25.SH INPUT/OUTPUT PARAMETER
26.ft R
27.TP 1i
28type_keyval
29Key value to free (integer).
30
31.SH OUTPUT PARAMETER
32.ft R
33.TP 1i
34IERROR
35Fortran only: Error status (integer).
36
37.SH DESCRIPTION
38.ft R
39
40.SH ERRORS
41Almost 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.
42.sp
43Before the error value is returned, the current MPI error handler is
44called. 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. 
45
46.SH SEE ALSO
47.ft R
48.sp
49MPI_Type_create_keyval
50.br
51
Note: See TracBrowser for help on using the repository browser.