Poster of Linux kernelThe best gift for a Linux geek
MPIL_Request_get_name

MPIL_Request_get_name

Section: LAM/MPI (3) Updated: 2/23/2006
Local index Up
 

NAME

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

SYNOPSIS

#include <mpi.h>
char *
MPIL_Request_get_name(MPI_Request req)
 

INPUT PARAMETERS

req
- MPI_Request (handle)

 

RETURN VALUE

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

 

ERRORS

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 exceptions 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.

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. This is typically a NULL pointer or other such error.

 

SEE ALSO

MPIL_Request_set_name
 

LOCATION

mpil_rgetname.c


 

Index

NAME
SYNOPSIS
INPUT PARAMETERS
RETURN VALUE
ERRORS
SEE ALSO
LOCATION

This document was created by man2html, using the manual pages.
Time: 21:50:40 GMT, April 16, 2011