openmpi/ompi/mpi/man/man3/MPI_Win_set_name.3in

.\" -*- nroff -*-
.\" Copyright 2013 Los Alamos National Security, LLC. All rights reserved.
.\" Copyright 2010 Cisco Systems, Inc.  All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" $COPYRIGHT$
.TH MPI_Win_set_name 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Win_set_name\fP \- Sets the name of a window.

.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Win_set_name(MPI_Win \fIwin\fP, const char *\fIwin_name\fP)

.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_WIN_SET_NAME(\fIWIN, WIN_NAME, IERROR\fP)
	INTEGER \fIWIN, IERROR\fP
	CHARACTER*(*) \fIWIN_NAME\fP

.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Win_set_name(\fIwin\fP, \fIwin_name\fP, \fIierror\fP)
	TYPE(MPI_Win), INTENT(IN) :: \fIwin\fP
	CHARACTER(LEN=*), INTENT(IN) :: \fIwin_name\fP
	INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP

.fi
.SH C++ Syntax
.nf
#include <mpi.h>
void MPI::Win::Set_name(const char* \fIwin_name\fP)

.fi
.SH INPUT/OUTPUT PARAMETER
.ft R
.TP 1i
win
Window whose identifier is to be set (handle).

.SH INPUT PARAMETER
.ft R
.TP 1i
win_name
The character string used as the name (string).

.SH OUTPUT PARAMETER
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).

.SH DESCRIPTION
.ft R

.SH 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.
.sp
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.