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

NAME

6       MPI_Win_set_name -  Set a name on a window
7

SYNOPSIS

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

INPUT PARAMETERS

14       win    - MPI window
15       name   - Pointer to the name of window
16
17

NOTES

19       This  function associates a name with a window, which can be useful for
20       debugging purposes.  The  function  MPI_Win_get_name  can  be  used  to
21       retrieve name that was previously set with MPI_Win_set_name .
22
23
24       Names passed in C must include the null terminator, and can be of maxi‐
25       mum length MPI_MAX_OBJECT_NAME (including the null terminator).   Names
26       passed in Fortran can also have a maximum length of MPI_MAX_OBJECT_NAME
27       .
28
29
30       Setting a name on a window that already has a name associated  with  it
31       replaces the old name.
32
33

ERRORS

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

SEE ALSO

68       MPI_Comm_set_name(3),    MPI_Comm_get_name(3),    MPI_Type_get_name(3),
69       MPI_Type_set_name(3), MPI_Win_get_name(3)
70
71

MORE INFORMATION

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

LOCATION

81       wsetname.c
82
83
84
85LAM/MPI 7.1.2                      2/23/2006               MPI_Win_set_name(3)