Man page - mpi_session_detach_buffer(3)

Packages contains this manual

Package: mpich-doc
apt-get install mpich-doc

Documentations in package:

Manual

MPI_Session_detach_buffer

NAME
SYNOPSIS
INPUT PARAMETERS
OUTPUT PARAMETERS
NOTES FOR FORTRAN
ERRORS
SEE ALSO

NAME

MPI_Session_detach_buffer - Removes an existing buffer (for use in MPI_Bsend etc) in the session

SYNOPSIS

int MPI_Session_detach_buffer(MPI_Session session, void *buffer_addr,
int *size)

int MPI_Session_detach_buffer_c(MPI_Session session, void *buffer_addr,
MPI_Count *size)

INPUT PARAMETERS

session

- session (handle)

OUTPUT PARAMETERS

buffer_addr

- initial buffer address (choice)

size

- buffer size, in bytes (integer)

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

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 argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler 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_SESSION

- Invalid session handle

MPI_ERR_OTHER

- Other error; use MPI_Error_string to get more information about this error code.