bionic (3) MPI_Win_set_name.openmpi.3.gz

NAME

       MPI_Win_set_name - Sets the name of a window.

SYNTAX

C Syntax

       #include <mpi.h>
       int MPI_Win_set_name(MPI_Win win, const char *win_name)

Fortran Syntax

       INCLUDE 'mpif.h'
       MPI_WIN_SET_NAME(WIN, WIN_NAME, IERROR)
            INTEGER WIN, IERROR
            CHARACTER*(*) WIN_NAME

C++ Syntax

       #include <mpi.h>
       void MPI::Win::Set_name(const char* win_name)

INPUT/OUTPUT PARAMETER

       win       Window whose identifier is to be set (handle).

INPUT PARAMETER

       win_name  The character string used as the name (string).

OUTPUT PARAMETER

       IERROR    Fortran only: Error status (integer).

DESCRIPTION

ERRORS

       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.

       Before the error value is returned, the current MPI error handler  is  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.