summaryrefslogtreecommitdiffstats
path: root/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java')
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java24
1 files changed, 23 insertions, 1 deletions
diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java
index a911a1c..ca10342 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5D_iterate_cb.java
@@ -13,7 +13,29 @@
package hdf.hdf5lib.callbacks;
-//Information class for link callback(for H5Diterate)
+/**
+ * Information class for link callback for H5Diterate.
+ *
+ */
public interface H5D_iterate_cb extends Callbacks {
+ /**
+ * application callback for each dataset element
+ *
+ * @param elem the pointer to the element in memory containing the current point
+ * @param elem_type the datatype ID for the elements stored in elem
+ * @param ndim the number of dimensions for POINT array
+ * @param point the array containing the location of the element within the original dataspace
+ * @param op_data the operator data passed in to H5Diterate
+ *
+ * @return 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.
+ */
int callback(byte[] elem, long elem_type, int ndim, long[] point, H5D_iterate_t op_data);
}