MPI_Info_create(3)

1MPI_Info_create(3)                  LAM/MPI                 MPI_Info_create(3)
2
3
4

NAME

6       MPI_Info_create -  Create and initialize an empty MPI_Info object
7

SYNOPSIS

9       #include <mpi.h>
10       int MPI_Info_create(MPI_Info *info)
11

OUTPUT PARAMETER

13       info   - info object (handle)
14
15

NOTES

17       Upon  successful  return,  the  created MPI_Info object will contain no
18       (key, value) pairs.
19
20       When an info object is no longer being used, it should  be  freed  with
21       MPI_Info_free .
22
23
24

NOTES FOR FORTRAN

26       All  MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
27       an additional argument ierr at the end of the argument list.   ierr  is
28       an  integer and has the same meaning as the return value of the routine
29       in C.  In Fortran, MPI routines are subroutines, and are  invoked  with
30       the call statement.
31
32       All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
33       Fortran.
34
35

ERRORS

37       If an error occurs in an MPI function, the current MPI error handler is
38       called  to  handle  it.   By default, this error handler aborts the MPI
39       job.  The error handler may be changed with  MPI_Errhandler_set  ;  the
40       predefined  error  handler MPI_ERRORS_RETURN may be used to cause error
41       values to be returned (in C and Fortran; this  error  handler  is  less
42       useful  in  with  the  C++  MPI bindings.  The predefined error handler
43       MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the  error  value
44       needs  to  be recovered).  Note that MPI does not guarantee that an MPI
45       program can continue past an error.
46
47       All MPI routines (except MPI_Wtime and  MPI_Wtick  )  return  an  error
48       value;  C routines as the value of the function and Fortran routines in
49       the last argument.  The C++ bindings for MPI do not return  error  val‐
50       ues;  instead,  error values are communicated by throwing exceptions of
51       type MPI::Exception (but not by default).  Exceptions are  only  thrown
52       if the error value is not MPI::SUCCESS .
53
54
55       Note  that  if  the MPI::ERRORS_RETURN handler is set in C++, while MPI
56       functions will return upon an error, there will be no  way  to  recover
57       what the actual error value was.
58       MPI_ERR_ARG
59              - Invalid argument.  Some argument is invalid and is not identi‐
60              fied by a specific  error  class.   This  is  typically  a  NULL
61              pointer or other such error.
62       MPI_ERR_OTHER
63              - This error is returned when some part of the LAM/MPI implemen‐
64              tation is unable to acquire memory.
65
66

MORE INFORMATION

72       For more information, please see the official MPI Forum web site, which
73       contains  the  text of both the MPI-1 and MPI-2 standards.  These docu‐
74       ments contain detailed information about each  MPI  function  (most  of
75       which is not duplicated in these man pages).
76
77       http://www.mpi-forum.org/
78

LOCATION

80       infocreate.c
81
82
83
84LAM/MPI 7.1.2                      2/23/2006                MPI_Info_create(3)