H5L.iterate
Iterates over links in a group, with user callback routine, according to the order within an index.
Parameters:
| group_id | Group identifier | |
| idx_type | Index type. One of {"H5_INDEX_NAME" | "H5_INDEX_CRT_ORDER"} | |
| order | Iteration order. One of {"H5_ITER_INC" | "H5_ITER_DEC" | "H5_ITER_NATIVE"} | |
| idx_in | Iteration index to allow continuing a previous iteration | |
| fcn | Callback function | |
| opdata_in | Callback data |
Return values:
| status | Negative value if the iteration were interrupted | |
| idx_out | Final iteration index | |
| opdata_out | Returned callback data |
Description:
The user callback function signature must be:
|
It receives and identifier for the currently visited object loc_id,
its name name and the data opdata_in as returned by the
previous iteration.
The function can return a negative status to instruct
H5L.iterate to stop iterations. Gathered data are returned in
opdata_out.
See original function at https://support.hdfgroup.org/documentation/hdf5/latest/group___t_r_a_v.html.
See also: H5L.iterate_by_name
Source Code: H5L.iterate