Recursively visits all objects starting from a specified object
Signature:
herr_t H5Ovisit_by_name( hid_t loc_id, const char *object_name, H5_index_t index_type, H5_iter_order_t order,
H5O_iterate_t op, void *op_data, unsigned int fields, hid_t lapl_id )
herr_t H5Ovisit_by_name( hid_t loc_id, const char *object_name, H5_index_t index_type, H5_iter_order_t order,
H5O_iterate_t op, void *op_data, hid_t lapl_id )
SUBROUTINE h5ovisit_by_name_f(loc_id, object_name, index_type, order, &
op, op_data, return_value, hdferr, lapl_id)
USE, INTRINSIC :: ISO_C_BINDING
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: loc_id
CHARACTER(LEN=*), INTENT(IN) :: object_name
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
INTEGER(HID_T) , INTENT(IN) , OPTIONAL :: lapl_id
Description:
H5O_VISIT_BY_NAME 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_BY_NAME is mapped to H5O_VISIT_BY_NAME3. In HDF5 version 1.10, H5O_VISIT_BY_NAME is identical to H5O_VISIT_BY_NAME1.
If using 1.10 (1.10.3+) and encountering performance issues, please use H5O_VISIT_BY_NAME2 to limit the fields retrieved, which can help with performance.
Specific compile-time compatibility flags and the resulting mappings are as follows:
| No compatibility flag | H5O_VISIT_BY_NAME3 for 1.12 and above H5O_VISIT_BY_NAME1 for 1.10 or 1.8 |
| Emulate Release 1.12 interface | H5O_VISIT_BY_NAME3 |
Emulate Release 1.10 or1.8 interface | H5O_VISIT_BY_NAME1 |
History:
| Release | Change |
|---|
| 1.12.0 | The macro H5O_VISIT_BY_NAME and function H5O_VISIT_BY_NAME3 were added. |
| 1.10.5 | The macro H5O_VISIT_BY_NAME was removed. The functions H5O_VISIT_BY_NAME and H5O_VISIT_BY_NAME1 are identical in this release. This change was added to restore the broken API compatibility introduced in HDF5-1.10.3.
|
| 1.10.3 | The function H5O_VISIT_BY_NAME was renamed to H5O_VISIT_BY_NAME1. The macro H5O_VISIT_BY_NAME and the function H5O_VISIT_BY_NAME2 were introduced in this release. |
| 1.8.11 | Fortran subroutine introduced in this release. |
| 1.8.0 | Function introduced in this release. |
--- Last Modified: March 31, 2021 | 12:04 PM
