Last modified: 24 August 2012
Name: H5Ewalk

Signature:
herr_t H5Ewalk( H5E_direction_t direction, H5E_walk_t func, void * client_data )

herr_t H5Ewalk( hid_t estack_id, H5E_direction_t direction, H5E_walk_t func, void * client_data )

Purpose:
Walks an error stack, calling a specified function.

Description:
H5Ewalk is a macro that is mapped to either H5Ewalk1 or H5Ewalk2, depending on the needs of the application.

Such macros are provided to facilitate application compatibility. For more information on macro use and mappings, see the “API Compatibility Macros in HDF5” document.

When both the HDF5 Library and the application are built and installed with no specific compatibility flags, H5Ewalk is mapped to the most recent version of the function, currently H5Ewalk2. If the library and/or application is compiled for Release 1.6 emulation, H5Ewalk will be mapped to H5Ewalk1. 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 H5Ewalk mapping

Global settings
No compatibility flag H5Ewalk2 
Enable deprecated symbols H5Ewalk2 
Disable deprecated symbols H5Ewalk2 
Emulate Release 1.6 interface     H5Ewalk1 

Function-level macros
H5Ewalk_vers = 2 H5Ewalk2
H5Ewalk_vers = 1 H5Ewalk1

Programming Note for 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 H5Pset_elink_cb and H5Pset_type_conv_cb and functions such as H5Tconvert and H5Ewalk2.

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.

Fortran90 Interface:
None.

History:
Release     C
1.8.0 The function H5Ewalk renamed to H5Ewalk1 and deprecated in this release.
The macro H5Ewalk and the function H5Ewalk2 introduced in this release.