source: proiecte/hpl/openmpi_compiled/share/man/man3/MPI_Win_get_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 Corporation
3.TH MPI_Win_get_name 3 "Dec 08, 2009" "1.4" "Open MPI"
4.SH NAME
5\fBMPI_Win_get_name\fP \- Obtains the name of a window.
6
7.SH SYNTAX
8.ft R
9.SH C Syntax
10.nf
11#include <mpi.h>
12int MPI_Win_get_name(MPI_Win \fIwin\fP, char *\fIwin_name\fP, int *\fIresultlen\fP)
13
14.SH Fortran Syntax
15.nf
16INCLUDE 'mpif.h'
17MPI_WIN_GET_NAME(\fIWIN, WIN_NAME, RESULTLEN, IERROR\fP)
18        INTEGER \fIWIN, RESULTLEN, IERROR\fP
19        CHARACTER*(*) \fIWIN_NAME\fP
20
21.SH C++ Syntax
22.nf
23#include <mpi.h>
24void MPI::Win::Get_name(char* \fIwin_name\fP, int& \fIresultlen\fP) const
25
26.SH INPUT PARAMETER
27.ft R
28.TP 1i
29win
30Window whose name is to be returned (handle).
31
32.SH OUTPUT PARAMETERS
33.ft R
34.TP 1i
35win_name
36the Tame previously stored on the window, or an empty string if no such name exists (string).
37.TP 1i
38resultlen
39Length of returned name (integer).
40.TP 1i
41IERROR
42Fortran only: Error status (integer).
43
44.SH DESCRIPTION
45.ft R
46
47.SH ERRORS
48Almost 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.
49.sp
50Before the error value is returned, the current MPI error handler is
51called. 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. 
52
53
Note: See TracBrowser for help on using the repository browser.