Last modified: 24 May 2009
Name: H5Eclear
Signature:
  herr_t `H5Eclear1`( `void` )

  herr_t `H5Eclear2`( hid_t `estack_id` )
Purpose:
  Clears an error stack.
Description:
  `H5Eclear` is a macro that is mapped to either `H5Eclear1` or `H5Eclear2`, 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”; we urge you to read that document closely.

  When both the HDF5 Library and the application are built and installed with no specific compatibility flags, `H5Eclear` is mapped to the most recent version of the function, currently `H5Eclear2`. If the library and/or application is compiled for Release 1.6 emulation, `H5Eclear` will be mapped to `H5Eclear1`. 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 setting | `H5Eclear` mapping
  --- | ---
  Global settings
  No compatibility flag | `H5Eclear2`
  Enable deprecated symbols | `H5Eclear2`
  Disable deprecated symbols | `H5Eclear2`
  Emulate Release 1.6 interface`` | `H5Eclear1`
  Function-level macros
  `H5Eclear_vers = 2` | `H5Eclear2`
  `H5Eclear_vers = 1` | `H5Eclear1`

Fortran90 Interface: h5eclear_f

      SUBROUTINE h5eclear_f(hdferr)
        IMPLICIT NONE
        INTEGER, INTENT(OUT) :: hdferr  ! Error code

      END SUBROUTINE h5eclear_f

History:

  Release | C
  1.8.0 | The function `H5Eclear` renamed to `H5Eclear1` and deprecated in this release. The macro `H5Eclear` and the function `H5Eclear2` introduced in this release.