H5L - HDF5 Functions related to links

Functions
herr_t	H5Literate2 (hid_t group_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx_p, H5L_iterate2_t op, void *op_data)
herr_t	H5Literate_by_name2 (hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx_p, H5L_iterate2_t op, void *op_data, hid_t lapl_id)
herr_t	H5Lvisit2 (hid_t group_id, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate2_t op, void *op_data)

Detailed Description

Function Documentation

H5Literate2()

herr_t H5Literate2	(	hid_t	group_id,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t *	idx_p,
		H5L_iterate2_t	op,
		void *	op_data
	)

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

Same pattern of behavior as H5Giterate.

Returns

Success: The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. Failure: Negative if something goes wrong within the library, or the negative value returned by one of the operators.

Parameters

group_id	The group ID to iterate over
idx_type	The index type
order	Specifies the order how to iterate
idx_p	Pointer to an iteration index such to allow continuing a previous iteration
op	Function pointer for a callback operation to be invoked at each iteration
op_data	User-defined data structure that will be passed on to the callback function

See also

See also H5Literate_by_name(), H5Lvisit2(), H5Lvisit_by_name()

Note

This function is also available through the H5Literate() macro.

---

H5Literate_by_name2()

herr_t H5Literate_by_name2	(	hid_t	loc_id,
		const char *	group_name,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		hsize_t *	idx_p,
		H5L_iterate2_t	op,
		void *	op_data,
		hid_t	lapl_id
	)

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

Same pattern of behavior as H5Giterate.

Returns

Success: The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. Failure: Negative if something goes wrong within the library, or the negative value returned by one of the operators.

Author

Quincey Koziol

Date

Thursday, November 16, 2006

---

H5Lvisit2()

herr_t H5Lvisit2	(	hid_t	group_id,
		H5_index_t	idx_type,
		H5_iter_order_t	order,
		H5L_iterate2_t	op,
		void *	op_data
	)

Recursively visit all the links in a group and all the groups that are linked to from that group. Links within each group are visited according to the order within the specified index (unless the specified index does not exist for a particular group, then the "name" index is used).

NOTE: Each link reachable from the initial group will only be visited once. However, because an object may be reached from more than one link, the visitation may call the application's callback with more than one link that points to a particular object.

Returns

Success: The return value of the first operator that returns non-zero, or zero if all members were processed with no operator returning non-zero. Failure: Negative if something goes wrong within the library, or the negative value returned by one of the operators.

Author

Quincey Koziol

Date

November 24 2007

---