1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Get_processor_name 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Get_processor_name \fP \- Gets the name of the processor. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Get_processor_name(char *\fIname\fP, int *\fIresultlen\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .nf |
---|
16 | INCLUDE 'mpif.h' |
---|
17 | MPI_GET_PROCESSOR_NAME(\fINAME, RESULTLEN, IERROR\fP) |
---|
18 | CHARACTER*(*) \fINAME\fP |
---|
19 | INTEGER \fIRESULTLEN, IERROR \fP |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void Get_processor_name(char* \fIname\fP, int& \fIresultlen\fP) |
---|
25 | |
---|
26 | .SH OUTPUT PARAMETERS |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | name |
---|
30 | A unique specifier for the actual (as opposed to virtual) node. |
---|
31 | .TP 1i |
---|
32 | resultlen |
---|
33 | Length (in characters) of result returned in name. |
---|
34 | .ft R |
---|
35 | .TP 1i |
---|
36 | IERROR |
---|
37 | Fortran only: Error status (integer). |
---|
38 | |
---|
39 | .SH DESCRIPTION |
---|
40 | .ft R |
---|
41 | This routine returns the name of the processor on which it was called at the moment of the call. The name is a character string for maximum flexibility. From this value it must be possible to identify a specific piece of hardware. The argument name must represent storage that is at least MPI_MAX_PROCESSOR_NAME characters long. |
---|
42 | .sp |
---|
43 | The number of characters actually written is returned in the output |
---|
44 | argument, resultlen. |
---|
45 | .sp |
---|
46 | .SH NOTES |
---|
47 | .ft R |
---|
48 | The user must provide at least MPI_MAX_PROCESSOR_NAME space to write the processor name; processor names can be this long. The user should examine the output argument, resultlen, to determine the actual length of the name. |
---|
49 | .sp |
---|
50 | |
---|
51 | .SH ERRORS |
---|
52 | Almost 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. |
---|
53 | .sp |
---|
54 | Before the error value is returned, the current MPI error handler is |
---|
55 | called. 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. |
---|
56 | |
---|
57 | |
---|
58 | |
---|