MPI_Win_get_name(3)

1MPI_Win_get_name(3)                 LAM/MPI                MPI_Win_get_name(3)
2
3
4

NAME

6       MPI_Win_get_name -  Get the name associated with a window
7

SYNOPSIS

9       #include <mpi.h>
10       int
11       MPI_Win_get_name(MPI_Win win, char *name, int *length)
12

INPUT PARAMETERS

14       type   - MPI window
15
16

OUTPUT PARAMETERS

18       name   - Name of the window
19       length - Integer length of the resulting name
20
21

NOTES

23       This function returns the name of a window that was previously set with
24       MPI_Win_set_name .  If a name was not previously associated with a win‐
25       dow,  the  returned  string  will  be  empty and length will be 0.  The
26       retuned name will be a maximum of MPI_MAX_OBJECT_NAME characters long.
27
28

ERRORS

30       If an error occurs in an MPI function, the current MPI error handler is
31       called  to  handle  it.   By default, this error handler aborts the MPI
32       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
33       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
34       values to be returned (in C and Fortran; this  error  handler  is  less
35       useful  in  with  the  C++  MPI bindings.  The predefined error handler
36       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
37       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
38       program can continue past an error.
39
40       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
41       value;  C routines as the value of the function and Fortran routines in
42       the last argument.  The C++ bindings for MPI do not return  error  val‐
43       ues;  instead,  error values are communicated by throwing exceptions of
44       type MPI::Exception (but not by default).  Exceptions are  only  thrown
45       if the error value is not MPI::SUCCESS .
46
47
48       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
49       functions will return upon an error, there will be no  way  to  recover
50       what the actual error value was.
51       MPI_SUCCESS
52              - No error; MPI routine completed successfully.
53       MPI_ERR_COMM
54              -  Invalid communicator.  A common error is to use a null commu‐
55              nicator in a call (not even allowed in MPI_Comm_rank ).
56       MPI_ERR_ARG
57              - Invalid argument.  Some argument is invalid and is not identi‐
58              fied  by  a  specific  error  class.   This  is typically a NULL
59              pointer or other such error.
60
61

MORE INFORMATION

68       For more information, please see the official MPI Forum web site, which
69       contains the text of both the MPI-1 and MPI-2 standards.   These  docu‐
70       ments  contain  detailed  information  about each MPI function (most of
71       which is not duplicated in these man pages).
72
73       http://www.mpi-forum.org/
74

LOCATION

76       wgetname.c
77
78
79
80LAM/MPI 7.1.2                      2/23/2006               MPI_Win_get_name(3)