Unix/Linux Go Back    

RedHat 9 (Linux i386) - man page for mpi_info_get (redhat section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)

MPI_Info_get(3) 			     LAM/MPI				  MPI_Info_get(3)

       MPI_Info_get -  Get a (key, value) pair from an MPI_Info object

       #include <mpi.h>
       int MPI_Info_get(MPI_Info info, char *key,
	  int valuelen, char *value, int *flag)

       info   - info object (handle)
       key    - null-terminated character string of the index key
	      - maximum length of value (integer)

       value  - null-terminated character string of the value
       flag   - true (1) if key defined on info , false (0) if not (logical)

       In  C  and  C++, valuelen should be one less than the allocated space to allow for for the
       null terminator.

       All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have an additional argu-
       ment ierr at the end of the argument list.  ierr is an integer 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 statement.

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

       If  an  error occurs in an MPI function, the current MPI error handler is called to handle
       it.  By default, this error handler aborts the MPI job.	The error handler may be  changed
       with  MPI_Errhandler_set  ;  the predefined error handler MPI_ERRORS_RETURN may be used to
       cause error values to be returned (in C and Fortran; this error handler is less useful  in
       with  the  C++  MPI  bindings.	The predefined error handler MPI::ERRORS_THROW_EXCEPTIONS
       should be used in C++ if the error value needs to be recovered).  Note that MPI	does  not
       guarantee that an MPI program can continue past an error.

       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 argument.  The C++ bindings for
       MPI  do not return error values; instead, error values are communicated by throwing excep-
       tions of type MPI::Exception (but not by default).  Exceptions  are  only  thrown  if  the
       error value is not MPI::SUCCESS

       Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI functions will return
       upon an error, there will be no way to recover what the actual error value was.
	      - No error; MPI routine completed successfully.
	      - Invalid argument.  Some argument is invalid and is not identified by  a  specific
	      error class.  This is typically a NULL pointer or other such error.
	      - This error class is associated with an error code that indicates that a null key,
	      empty key, or key that was longer than MPI_MAX_INFO_KEY characters was passed as an
	      argument to an MPI function where it was not allowed.

       For  more information, please see the official MPI Forum web site, which contains the text
       of both the MPI-1 and MPI-2 standards.  These documents contain detailed information about
       each MPI function (most of which is not duplicated in these man pages).



LAM/MPI 6.5.8				    11/10/2002				  MPI_Info_get(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums

All times are GMT -4. The time now is 02:24 AM.