1
1
openmpi/ompi/mpi/man/man3/MPI_Win_delete_attr.3in
2016-11-22 15:03:20 -08:00

72 строки
2.2 KiB
Plaintext

.\" -*- nroff -*-
.\" Copyright (c) 2010-2014 Cisco Systems, Inc. All rights reserved.
.\" Copyright 2006-2008 Sun Microsystems, Inc.
.\" Copyright (c) 1996 Thinking Machines Corporation
.\" $COPYRIGHT$
.TH MPI_Win_delete_attr 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
.SH NAME
\fBMPI_Win_delete_attr\fP \- Deletes an attribute from a window.
.SH SYNTAX
.ft R
.SH C Syntax
.nf
#include <mpi.h>
int MPI_Win_delete_attr(MPI_Win \fIwin\fP, int \fIwin_keyval\fP)
.fi
.SH Fortran Syntax
.nf
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_WIN_DELETE_ATTR(\fIWIN, WIN_KEYVAL, IERROR\fP)
INTEGER \fIWIN, WIN_KEYVAL, IERROR\fP
.fi
.SH Fortran 2008 Syntax
.nf
USE mpi_f08
MPI_Win_delete_attr(\fIwin\fP, \fIwin_keyval\fP, \fIierror\fP)
TYPE(MPI_Win), INTENT(IN) :: \fIwin\fP
INTEGER, INTENT(IN) :: \fIwin_keyval\fP
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
.fi
.SH C++ Syntax
.nf
#include <mpi.h>
void MPI::Win::Delete_attr(int \fIwin_keyval\fP)
.fi
.SH INPUT/OUTPUT PARAMETER
.ft R
.TP 1i
win
Window from which the attribute is deleted (handle).
.SH INPUT PARAMETER
.ft R
.TP 1i
win_keyval
Key value (integer).
.SH OUTPUT PARAMETER
.ft R
.TP 1i
IERROR
Fortran only: Error status (integer).
.SH NOTES
Note that it is not defined by the MPI standard what happens if the
delete_fn callback invokes other MPI functions. In Open MPI, it is
not valid for delete_fn callbacks (or any of their children) to add or
delete attributes on the same object on which the delete_fn callback
is being invoked.
.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.