Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
MPI_Info_get_valuelen(3)	       MPI		MPI_Info_get_valuelen(3)

NAME
     MPI_Info_get_valuelen  -  Retrieves the length of the value associated with
     a key

SYNOPSIS
     int MPI_Info_get_valuelen(MPI_Info info, const char *key, int *valuelen,
     int *flag)

INPUT PARAMETERS
     info   - info object (handle)
     key    - key (string)

OUTPUT PARAMETERS
     valuelen
	    - length of value arg (integer)
     flag   - true if key defined, false if not (boolean)

DEPRECATED FUNCTION
     The current MPI standard defines this routine as  deprecated.  The  routine
     may  continue  to be used, but new code should use the replacement routine.
     MPI_Info_get_string should be used instead of this routine.

THREAD AND INTERRUPT SAFETY
     This routine is thread-safe.  This means that this routine  may  be  safely
     used  by  multiple  threads  without  the need for any user-provided thread
     locks.  However, the routine is not interrupt safe.  Typically, this is due
     to the use of memory allocation routines such as malloc or other  non-MPICH
     runtime routines that are themselves not interrupt-safe.

NOTES FOR FORTRAN
     All  MPI  routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an
     additional argument ierr at the end of the argument list.	ierr is an inte-
     ger and has the same meaning as the return value of the routine in  C.   In
     Fortran, MPI routines are subroutines, and are invoked with the call state-
     ment.

     All  MPI  objects	(e.g.,	MPI_Datatype , MPI_Comm ) are of type INTEGER in
     Fortran.

ERRORS
     All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C
     routines as the value of the function and Fortran routines in the last  ar-
     gument.   Before  the  value  is returned, the current MPI error handler is
     called.  By default, this error handler aborts the MPI job.  The error han-
     dler may  be  changed  with  MPI_Comm_set_errhandler  (for  communicators),
     MPI_File_set_errhandler  (for  files),  and MPI_Win_set_errhandler (for RMA
     windows).	The MPI-1 routine MPI_Errhandler_set may be used but its use  is
     deprecated.   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; however, MPI implementations
     will attempt to continue whenever possible.

     MPI_SUCCESS
	    - No error; MPI routine completed successfully.
     MPI_ERR_ARG
	    - Invalid argument.  Some argument is invalid and is not  identified
	    by a specific error class (e.g., MPI_ERR_RANK ).
     MPI_ERR_INFO
	    - Invalid Info
     MPI_ERR_OTHER
	    -  Other  error;  use MPI_Error_string to get more information about
	    this error code.

				    4/10/2026		MPI_Info_get_valuelen(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Info_get_valuelen&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help