H5D_iterate_cb Interface Reference

Detailed Description

Information class for link callback for H5Diterate.

Inheritance diagram for H5D_iterate_cb:

Public Member Functions
int	callback (byte[] elem, long elem_type, int ndim, long[] point, H5D_iterate_t op_data)

Member Function Documentation

callback()

int callback	(	byte[]	elem,
		long	elem_type,
		int	ndim,
		long[]	point,
		H5D_iterate_t	op_data
	)

application callback for each dataset element

Parameters

elem	the pointer to the element in memory containing the current point
elem_type	the datatype ID for the elements stored in elem
ndim	the number of dimensions for POINT array
point	the array containing the location of the element within the original dataspace
op_data	the operator data passed in to H5Diterate

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/H5D_iterate_cb.java