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

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

Adding compiled files

File size: 1.7 KB
Line 
1.\"Copyright 2006-2008 Sun Microsystems, Inc.
2.\"Copyright (c) 1996 Thinking Machines
3.TH MPI_Type_set_name 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Type_set_name\fP \- Sets the name of a data type.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Type_set_name(MPI_Datatype \fItype\fP, char *\fItype_name\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_TYPE_SET_NAME(\fITYPE, TYPE_NAME, IERROR\fP)
18        INTEGER \fITYPE, IERROR\fP
19        CHARACTER*(*) \fITYPE_NAME\fP
20
21.SH C++ Syntax
22.nf
23#include <mpi.h>
24void MPI::Datatype::Set_name(const char* \fItype_name\fP)
25
26.SH INPUT/OUTPUT PARAMETER
27.ft R
28.TP 1i
29type
30Data type for which the identifier is to be set (handle).
31
32.SH INPUT PARAMETER
33.ft R
34.TP 1i
35type_name
36The character string remembered as the name (string).
37
38.SH OUTPUT PARAMETER
39.ft R
40.TP 1i
41IERROR
42Fortran only: Error status (integer).
43
44
45.SH DESCRIPTION
46.ft R
47MPI_Type_set_name associates a printable identifier with an MPI data type.
48
49.SH ERRORS
50Almost 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.
51.sp
52Before the error value is returned, the current MPI error handler is
53called. 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. 
54
55.SH SEE ALSO
56.ft R
57.sp
58MPI_Type_get_name
59.br
60
Note: See TracBrowser for help on using the repository browser.