2016-11-22 15:03:20 -08:00
.\" -*- nroff -*-
.\" Copyright 2010 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
2020-02-18 22:42:21 -08:00
.\" Copyright (c) 2020 Google, LLC. All rights reserved.
2016-11-22 15:03:20 -08:00
.\" $COPYRIGHT$
.TH MPI_Win_free_keyval 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Win_free_keyval\fP \- Frees a window keyval.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Win_free_keyval(int *\fIwin_keyval\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_WIN_FREE_KEYVAL(\fIWIN_KEYVAL, IERROR\fP)
INTEGER \fIWIN_KEYVAL, IERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Win_free_keyval(\fIwin_keyval\fP, \fIierror\fP)
INTEGER, INTENT(INOUT) :: \fIwin_keyval\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH INPUT/OUTPUT PARAMETER
.ft R
.TP 1i
win_keyval
Key value (integer).
.SH OUTPUT PARAMETER
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH ERRORS
2020-02-18 22:42:21 -08:00
Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.
2016-11-22 15:03:20 -08:00
.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.
