bionic (3) MPI_Win_get_info.3.gz

Provided by: mpich-doc_3.3~a2-4_all bug

NAME

       MPI_Win_get_info -  Returns a new info object containing the hints of the window associated with win.

SYNOPSIS

       int MPI_Win_get_info(MPI_Win win, MPI_Info *info_used)

       The  current  setting  of  all  hints  actually  used by the system related to this window is returned in
       info_used. If no such hints exist, a handle to a newly created info object is returned that  contains  no
       key/value pair. The user is responsible for freeing info_used via MPI_Info_free .

INPUT PARAMETERS

       win    - window object (handle)

OUTPUT PARAMETERS

       info_used
              - new info argument (handle)

NOTES

       The  info  object returned in info_used will contain all hints currently active for this window. This set
       of hints may be greater or smaller than the set of hints specified when the window was  created,  as  the
       system  may not recognize some hints set by the user, and may recognize other hints that the user has not
       set.

THREAD AND INTERRUPT SAFETY

       This routine is thread-safe.  This means that this routine may be safely used by multiple threads without
       the  need  for  any  user-provided thread locks.  However, the routine is not interrupt safe.  Typically,
       this is due to the use of memory allocation routines such as malloc or other non-MPICH  runtime  routines
       that are themselves not interrupt-safe.

NOTES FOR FORTRAN

       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argument ierr at the
       end of the argument list.  ierr is an integer and has the same meaning as the return value of the routine
       in C.  In Fortran, MPI routines are subroutines, and are invoked with the call statement.

       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in Fortran.

ERRORS

       All  MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C routines as the value of the
       function and Fortran routines in the last argument.  Before the value is returned, the current MPI  error
       handler  is called.  By default, this error handler aborts the MPI job.  The error handler may be changed
       with   MPI_Comm_set_errhandler   (for   communicators),   MPI_File_set_errhandler   (for   files),    and
       MPI_Win_set_errhandler  (for  RMA windows).  The MPI-1 routine MPI_Errhandler_set may be used but its use
       is deprecated.  The predefined error handler MPI_ERRORS_RETURN may be used to cause error  values  to  be
       returned.   Note that MPI does not guarentee that an MPI program can continue past an error; however, MPI
       implementations will attempt to continue whenever possible.

       MPI_SUCCESS
              - No error; MPI routine completed successfully.
       MPI_ERR_ARG
              - Invalid argument.  Some argument is invalid and is not identified  by  a  specific  error  class
              (e.g., MPI_ERR_RANK ).
       MPI_ERR_WIN
              - Invalid MPI window object
       MPI_ERR_INFO
              - Invalid Info
       MPI_ERR_OTHER
              - Other error; use MPI_Error_string to get more information about this error code.

SEE ALSO

       MPI_Win_set_info

                                                   11/12/2016                                MPI_Win_get_info(3)