Recursively visits all objects accessible from a specified object

Signature:

<pre><code class="language-c">herr_t H5Ovisit( hid_t object_id, H5_index_t index_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data )</code></pre>
<pre><code class="language-c">herr_t H5Ovisit( hid_t object_id, H5_index_t index_type, H5_iter_order_t order, H5O_iterate_t op, void *op_data, unsigned int fields )</code></pre>

<pre><code class="language-fortran">SUBROUTINE h5ovisit_f(object_id, index_type, order, op, op_data, &
            return_value, hdferr)
    INTEGER(HID_T), INTENT(IN) :: object_id
    INTEGER, INTENT(IN) :: index_type 
    INTEGER, INTENT(IN) :: order

    TYPE(C_FUNPTR):: op
    TYPE(C_PTR)   :: op_data
    INTEGER, INTENT(OUT) :: return_value
    INTEGER, INTENT(OUT) :: hdferr</code></pre>

Description:

H5O_VISIT is a macro that is mapped to one of the following:

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.

In HDF5 versions 1.12 and after, H5O_VISIT is mapped to H5O_VISIT3. In version 1.10, H5O_VISIT is identical to H5O_VISIT1.

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

Compatibility settingsH5O_VISIT
No compatibility flag

H5O_VISIT3 in 1.12 or after

H5O_VISIT1 for 1.8 and 1.10

Emulate Release 1.12H5O_VISIT3
Emulate Release 1.10 or 1.8 interface 

H5O_VISIT1

 

Example:

History:
Release    Change
1.12.0The macro H5O_VISIT and function H5O_VISIT3 were added, and H5O_VISIT1 was deprecated.
1.10.5The macro H5O_VISIT was removed. The functions H5O_VISIT and H5O_VISIT1 are identical in this release. This change was added to restore the broken API compatibility introduced in HDF5-1.10.3.
1.10.3The function H5O_VISIT was renamed to H5O_VISIT1. The macro H5O_VISIT and the function H5O_VISIT2 H5 were introduced in this release.
1.8.8Fortran subroutine and data structure added.
1.8.0C function introduced.