Page tree

 

JAVA

FORTRAN

C++

C

 

Link

H5O_VISIT_BY_NAME

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, hid_t lapl_id )
herr_t H5Ovisit_by_name2( 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 )

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 either H5O_VISIT_BY_NAME1 or H5O_VISIT_BY_NAME2.

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.

If the library and/or application is compiled for Release 1.8 or 1.10 emulation, H5O_VISIT_BY_NAME will be mapped to H5O_VISIT_BY_NAME1. With later versions, H5O_VISIT_BY_NAME is mapped to H5O_VISIT_BY_NAME2 (and H5O_VISIT_BY_NAME1 is deprecated).

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

No compatibility flag

H5Ovisit_by_name1 for  1.8 or 1.10

H5Ovisit_by_name2 for > 1.10

Emulate Release 1.8 interface H5Ovisit_by_name1
Emulate Release 1.10 interfaceH5Ovisit_by_name1
Emulate Releases after 1.10H5Ovisit_by_name2

Example:

History:
Release    Change
1.10.3The function H5Ovisit_by_name was renamed to H5Ovisit_by_name1. The macro H5Ovisit_by_name and the function H5Ovisit_by_name2 were introduced in this release.
1.8.11Fortran subroutine introduced in this release.
1.8.0Function introduced in this release.

--- Last Modified: August 22, 2018 | 01:14 PM