Last modified: 24 May 2009
Name: H5Eget_auto
Signature:
  herr_t `H5Eget_auto`( H5E_auto_t * `func`, void **`client_data` )

  herr_t `H5Eget_auto`( hid_t `estack_id`, H5E_auto_t * `func`, void **`client_data` )
Purpose:
  Returns settings for automatic error stack traversal function and its data.
Description:
  `H5Eget_auto` is a macro that is mapped to either `H5Eget_auto1` or `H5Eget_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”; 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, `H5Eget_auto` is mapped to the most recent version of the function, currently `H5Eget_auto2`. If the library and/or application is compiled for Release 1.6 emulation, `H5Eget_auto` will be mapped to `H5Eget_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 setting | `H5Eget_auto` mapping
  --- | ---
  Global settings
  No compatibility flag | `H5Eget_auto2`
  Enable deprecated symbols | `H5Eget_auto2`
  Disable deprecated symbols | `H5Eget_auto2`
  Emulate Release 1.6 interface`` | `H5Eget_auto1`
  Function-level macros
  `H5Eget_auto_vers = 2` | `H5Eget_auto2`
  `H5Eget_auto_vers = 1` | `H5Eget_auto1`

Fortran90 Interface: h5eget_auto_f
  None.

History:

  Release | C
  1.8.0 | The function `H5Eget_auto` renamed to `H5Eget_auto1` and deprecated in this release. The macro `H5Eget_auto` and the function `H5Eget_auto2` introduced in this release.