Categories &

Functions List

Function Reference: H5L.iterate_by_name

: [status, idx_out, opdata_out] = H5L.iterateiterate_by_name (group_id, name, idx_type, order, idx_in, fcn, opdata_in, lapl_id)

Iterates over links in a named group, with user callback routine, according to the order within an index.

Parameters:

group_idGroup identifier
nameGroup name
idx_typeIndex type. One of {"H5_INDEX_NAME" | "H5_INDEX_CRT_ORDER"}
orderIteration order. One of {"H5_ITER_INC" | "H5_ITER_DEC" | "H5_ITER_NATIVE"}
idx_inIteration index to allow continuing a previous iteration
fcnCallback function
opdata_inCallback data
lapl_idLink access property list identifier.

Return values:

statusNegative value if the iteration were interrupted
idx_outFinal iteration index
opdata_outReturned callback data

Description:

The user callback function signature must be:

 
 [status, opdata_out] = fcn (loc_id, name, opdata_in)

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_by_name