Turns automatic error printing on or off

Signature:

<pre><code class="language-c">herr_t H5Eset_auto( H5E_auto1_t func, void *client_data )</code></pre>

<pre><code class="language-c">herr_t H5Eset_auto( hid_t estack_id, H5E_auto2_t func, void *client_data )</code></pre>

Fortran90:

<pre><code class="language-fortran">SUBROUTINE h5eset_auto_f(printflag, hdferr)
  INTEGER, INTENT(IN) :: printflag  !flag to turn automatic error
                                    !printing on or off
                                    !possible values are:
                                    !printon (1)
                                    !printoff(0)
  INTEGER, INTENT(OUT) :: hdferr    ! Error code

END SUBROUTINE h5eset_auto_f</code></pre>

Fortran2003:

<pre><code class="language-fortran"> SUBROUTINE h5eset_auto_f(printflag, hdferr, estack_id, func, client_data)
    INTEGER       , INTENT(IN)            :: printflag
    INTEGER       , INTENT(OUT)           :: hdferr
    INTEGER(HID_T), INTENT(IN) , OPTIONAL :: estack_id
    TYPE(C_FUNPTR), INTENT(IN) , OPTIONAL :: func
    TYPE(C_PTR)   , INTENT(IN) , OPTIONAL :: client_data</code></pre>

Description:

H5E_SET_AUTO is a macro that is mapped to either H5E_SET_AUTO1 or H5E_SET_AUTO2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. Their use and mappings are fully described in API Compatibility Macros in HDF5.

When both the HDF5 library and the application are built and installed with no specific compatibility flags, H5E_SET_AUTO is mapped to the most recent version of the function, currently H5E_SET_AUTO2. If the library and/or application is compiled for Release 1.6 emulation, H5E_SET_AUTO will be mapped to H5E_SET_AUTO1. Function-specific flags are available to override these settings on a function-by-function basis when the application is compiled.

Specific compile-time compatibility flags and the resulting mappings are as follows:

Compatibility settingH5Eset_auto mapping

Global settings
No compatibility flagH5Eset_auto2 
Enable deprecated symbolsH5Eset_auto2 
Disable deprecated symbolsH5Eset_auto2 
Emulate Release 1.6 interface    H5Eset_auto1 

Function-level macros
H5Eset_auto_vers = 2H5Eset_auto2
H5Eset_auto_vers = 1H5Eset_auto1

C++ Developers Using C Functions:

If a C routine that takes a function pointer as an argument is called from within C++ code, the C routine should be returned from normally.

Examples of this kind of routine include callbacks such as H5P_SET_ELINK_CB and H5P_SET_TYPE_CONV_CB and functions such as H5T_CONVERT and H5E_WALK2.

Exiting the routine in its normal fashion allows the HDF5 C library to clean up its work properly. In other words, if the C++ application jumps out of the routine back to the C++ “catch” statement, the library is not given the opportunity to close any temporary data structures that were set up when the routine was called. The C++ application should save some state as the routine is started so that any problem that occurs might be diagnosed.

History:
ReleaseChange
1.8.0The function H5Eset_auto renamed to H5Eset_auto1 and deprecated in this release. 
The macro H5Eset_auto and the function H5Eset_auto2 introduced in this release.
1.8.8

Fortran 2003 version of Fortran subroutine added in this release.