Blame www/www3/MPI_Info_get_valuelen.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Info_get_valuelen</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Info_get_valuelen

Packit Service c5cf8c
Retrieves the length of the value associated with a key 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
#undef FUNCNAME
Packit Service c5cf8c
#define FUNCNAME MPIRInfo_get_valuelen
Packit Service c5cf8c
#undef FCNAME
Packit Service c5cf8c
#define FCNAME MPL_QUOTE(FUNCNAME)
Packit Service c5cf8c
int MPI_Info_get_valuelen(MPI_Info info, const char *key, int *valuelen, int *flag)
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
info
info object (handle)
Packit Service c5cf8c
Packit Service c5cf8c
key
key (string)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
valuelen
length of value argument (integer)
Packit Service c5cf8c
Packit Service c5cf8c
flag
true if key defined, false if not (boolean)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Packit Service c5cf8c

Thread and Interrupt Safety

Packit Service c5cf8c

Packit Service c5cf8c
This routine is thread and interrupt safe only if no MPI routine that
Packit Service c5cf8c
updates or frees the same <tt>MPI_Info</tt> object may be called concurrently
Packit Service c5cf8c
with this routine.
Packit Service c5cf8c

Packit Service c5cf8c
The MPI standard defined a thread-safe interface but this does not
Packit Service c5cf8c
mean that all routines may be called without any thread locks.  For
Packit Service c5cf8c
example, two threads must not attempt to change the contents of the
Packit Service c5cf8c
same <tt>MPI_Info</tt> object concurrently.  The user is responsible in this
Packit Service c5cf8c
case for using some mechanism, such as thread locks, to ensure that
Packit Service c5cf8c
only one thread at a time makes use of this routine.
Packit Service c5cf8c

Packit Service c5cf8c

Notes for Fortran

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

Packit Service c5cf8c
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit Service c5cf8c
</tt>in Fortran.
Packit Service c5cf8c

Packit Service c5cf8c

Errors

Packit Service c5cf8c

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

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_INFO_KEY
Invalid or null key string for info.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_OTHER
Other error; use <tt>MPI_Error_string</tt> to get more information
Packit Service c5cf8c
about this error code. 
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>