0b8baa217d
This commit contains the following changes: The C++ bindings were removed from the standard in MPI-3.0. This commit removes the entirety of the C++ bindings as well as the support configury. Removes all references to C++ from the man pages. This includes the bindings themselves, all references to what C++ bindings return, all not-available comments, and differences between C++ and other language bindings. If the user passes --enable-mpi-cxx, --enable-mpi-cxx-seek, or --enable-cxx-exceptions, print a warning message an abort configure. Signed-off-by: Jeff Squyres <jsquyres@cisco.com> Signed-off-by: Nathan Hjelm <hjelmn@google.com>
87 строки
2.6 KiB
Plaintext
87 строки
2.6 KiB
Plaintext
.\" -*- 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 (c) 2020 Google, LLC. All rights reserved.
|
|
.\" $COPYRIGHT$
|
|
.TH MPI_Info_get_valuelen 3 "#OMPI_DATE#" "#PACKAGE_VERSION#" "#PACKAGE_NAME#"
|
|
.SH NAME
|
|
\fBMPI_Info_get_valuelen\fP \- Retrieves the length of the key value associated with an info object.
|
|
|
|
.SH SYNTAX
|
|
.ft R
|
|
.SH C Syntax
|
|
.nf
|
|
#include <mpi.h>
|
|
int MPI_Info_get_valuelen(MPI_Info \fIinfo\fP, const char \fI*key\fP,
|
|
int \fI*valuelen\fP, int \fI*flag\fP)
|
|
|
|
.fi
|
|
.SH Fortran Syntax
|
|
.nf
|
|
USE MPI
|
|
! or the older form: INCLUDE 'mpif.h'
|
|
MPI_INFO_GET_VALUELEN(\fIINFO, KEY, VALUELEN, FLAG, IERROR\fP)
|
|
INTEGER \fIINFO, VALUELEN, IERROR\fP
|
|
LOGICAL \fIFLAG\fP
|
|
CHARACTER*(*) \fIKEY\fP
|
|
|
|
.fi
|
|
.SH Fortran 2008 Syntax
|
|
.nf
|
|
USE mpi_f08
|
|
MPI_Info_get_valuelen(\fIinfo\fP, \fIkey\fP, \fIvaluelen\fP, \fIflag\fP, \fIierror\fP)
|
|
TYPE(MPI_Info), INTENT(IN) :: \fIinfo\fP
|
|
CHARACTER(LEN=*), INTENT(IN) :: \fIkey\fP
|
|
INTEGER, INTENT(OUT) :: \fIvaluelen\fP
|
|
LOGICAL, INTENT(OUT) :: \fIflag\fP
|
|
INTEGER, OPTIONAL, INTENT(OUT) :: \fIierror\fP
|
|
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
info
|
|
Info object (handle).
|
|
.ft R
|
|
.TP 1i
|
|
key
|
|
Key (string).
|
|
|
|
.SH OUTPUT PARAMETERS
|
|
.ft R
|
|
.TP 1i
|
|
valuelen
|
|
Length of value arg (integer).
|
|
.ft R
|
|
.TP 1i
|
|
flag
|
|
Returns true if key defined, false if not (boolean).
|
|
.ft R
|
|
.TP 1i
|
|
IERROR
|
|
Fortran only: Error status (integer).
|
|
|
|
.SH DESCRIPTION
|
|
.ft R
|
|
MPI_Info_get_valuelen retrieves the length of the \fIvalue\fP associated with \fIkey\fP. If \fIkey\fP is defined, \fIvaluelen\fP is set to the length of its associated value and \fIflag\fP is set to true. If \fIkey\fP is not defined, \fIvaluelen\fP is not touched and \fIflag\fP is set to false. The length returned in C does not include the end-of-string character.
|
|
.sp
|
|
If \fIkey\fP is larger than MPI_MAX_INFO_KEY, the call is erroneous.
|
|
|
|
.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.
|
|
.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.
|
|
|
|
.SH SEE ALSO
|
|
.ft r
|
|
MPI_Info_get
|
|
.br
|
|
MPI_Info_get_nkeys
|
|
.br
|
|
MPI_Info_get_nthkey
|
|
.br
|
|
|