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

NAME

6       MPIL_Request_get_name -  LAM/MPI-specific function to get a string name
7       on an MPI_Request
8

SYNOPSIS

10       #include <mpi.h>
11       char *
12       MPIL_Request_get_name(MPI_Request req)
13

INPUT PARAMETERS

15       req    - MPI_Request (handle)
16
17

RETURN VALUE

19       If a valid MPI_Request is passed to this function, a valid string  will
20       be  returned,  even if no name was ever set on the request.  The string
21       that is returned is a pointer to internal storage  and  should  not  be
22       modified or freed.
23
24

ERRORS

26       If an error occurs in an MPI function, the current MPI error handler is
27       called to handle it.  By default, this error  handler  aborts  the  MPI
28       job.   The  error  handler may be changed with MPI_Errhandler_set ; the
29       predefined error handler MPI_ERRORS_RETURN may be used to  cause  error
30       values  to  be  returned  (in C and Fortran; this error handler is less
31       useful in with the C++ MPI  bindings.   The  predefined  error  handler
32       MPI::ERRORS_THROW_EXCEPTIONS  should  be used in C++ if the error value
33       needs to be recovered).  Note that MPI does not guarantee that  an  MPI
34       program can continue past an error.
35
36       All  MPI  routines  (except  MPI_Wtime  and MPI_Wtick ) return an error
37       value; C routines as the value of the function and Fortran routines  in
38       the  last  argument.  The C++ bindings for MPI do not return error val‐
39       ues; instead, error values are communicated by throwing  exceptions  of
40       type  MPI::Exception  (but not by default).  Exceptions are only thrown
41       if the error value is not MPI::SUCCESS .
42
43
44       Note that if the MPI::ERRORS_RETURN handler is set in  C++,  while  MPI
45       functions  will  return  upon an error, there will be no way to recover
46       what the actual error value was.
47       MPI_SUCCESS
48              - No error; MPI routine completed successfully.
49       MPI_ERR_ARG
50              - Invalid argument.  Some argument is invalid and is not identi‐
51              fied  by  a  specific  error  class.   This  is typically a NULL
52              pointer or other such error.
53
54

SEE ALSO

56       MPIL_Request_set_name
57

LOCATION

59       mpil_rgetname.c
60
61
62
63LAM/MPI 7.1.2                      2/23/2006          MPIL_Request_get_name(3)
Impressum