H5O_iterate_t Interface Reference

Detailed Description

Information class for link callback for H5Ovisit/H5Ovisit_by_name.

Inheritance diagram for H5O_iterate_t:

Public Member Functions
int	callback (long loc_id, String name, H5O_info_t info, H5O_iterate_opdata_t op_data)

Member Function Documentation

callback()

int callback	(	long	loc_id,
		String	name,
		H5O_info_t	info,
		H5O_iterate_opdata_t	op_data
	)

application callback for each group

Parameters

loc_id	the ID for the group or dataset being iterated over
name	the name of the current object
info	the object's "info" struct
op_data	the operator data passed in to H5Oiterate

Returns

operation status A. Zero causes the iterator to continue, returning zero when all attributes have been processed. B. Positive causes the iterator to immediately return that positive value, indicating short-circuit success. The iterator can be restarted at the next attribute. C. Negative causes the iterator to immediately return that value, indicating failure. The iterator can be restarted at the next attribute.

---

The documentation for this interface was generated from the following file:

• java/src/hdf/hdf5lib/callbacks/H5O_iterate_t.java