Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 2.24 KB

MPI_Comm_create_errhandler.3.rst

File metadata and controls

93 lines (62 loc) · 2.24 KB
Raw

MPI_Comm_create_errhandler

:ref:`MPI_Comm_create_errhandler` |mdash| Creates an error handler that can be attached to communicators.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_Comm_create_errhandler(MPI_Comm_errhandler_function *function,
    MPI_Errhandler *errhandler)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_COMM_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
    EXTERNAL    FUNCTION
    INTEGER ERRHANDLER, IERROR

Fortran 2008 Syntax

USE mpi_f08

MPI_Comm_create_errhandler(comm_errhandler_fn, errhandler, ierror)
    PROCEDURE(MPI_Comm_errhandler_function) :: comm_errhandler_fn
    TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

Deprecated Type Name Note

MPI-2.2 deprecated the MPI_Comm_errhandler_fn type in favor of MPI_Comm_errhandler_function. Open MPI supports both names (indeed, the _fn names are typedefs to the _function names).

INPUT PARAMETER

  • function : User-defined error handling procedure (function).

OUTPUT PARAMETERS

  • errhandler : MPI error handler (handle).
  • ierror : Fortran only: Error status (integer).

DESCRIPTION

:ref:`MPI_Comm_create_errhandler` creates an error handler that can be attached to communicators. This function is identical to :ref:`MPI_Errhandler_create`, the use of which is deprecated. In C, the user routine should be a function of type MPI_Comm_errhandler_function, which is defined as

typedef void MPI_Comm_errhandler_function(MPI_Comm *, int *, ...);

The first argument is the communicator in use. The second is the error code to be returned by the MPI routine that raised the error. This typedef replaces MPI_Handler_function, the use of which is deprecated. In Fortran, the user routine should be of this form:

SUBROUTINE COMM_ERRHANDLER_FUNCTION(COMM, ERROR_CODE, ...)
   INTEGER COMM, ERROR_CODE

ERRORS