Skip to content

Latest commit

 

History

History
97 lines (59 loc) · 2.07 KB

MPI_File_create_errhandler.3.rst

File metadata and controls

97 lines (59 loc) · 2.07 KB
Raw

MPI_File_create_errhandler

:ref:`MPI_File_create_errhandler` |mdash| Creates an MPI-style error handler that can be attached to a file.

SYNTAX

C Syntax

#include <mpi.h>

int MPI_File_create_errhandler(MPI_File_errhandler_function *function,
     MPI_Errhandler *errhandler)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
     EXTERNAL        FUNCTION
     INTEGER ERRHANDLER, IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_File_create_errhandler(file_errhandler_fn, errhandler, ierror)
     PROCEDURE(MPI_File_errhandler_function) :: file_errhandler_fn
     TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

DEPRECATED TYPE NAME NOTE

MPI-2.2 deprecated the MPI_File_errhandler_fn type in favor of MPI_File_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 file operations. In C, the user routine should be a function of type MPI_File_errhandler_function, which is defined as

typedef void (MPI_File_errhandler_function)(MPI_File *, int *, ...);

The first argument is the file in use. The second is the error code to be returned by the MPI routine that raised the error.

In the Fortran language, the user routine should be of the form:

SUBROUTINE FILE_ERRHANDLER_FUNCTION(FILE, ERROR_CODE, ...)
    INTEGER FILE, ERROR_CODE

ERRORS