summaryrefslogtreecommitdiffstats
path: root/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java')
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java21
1 files changed, 20 insertions, 1 deletions
diff --git a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java
index e77d386..78a87ad 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5P_cls_close_func_cb.java
@@ -13,7 +13,26 @@
package hdf.hdf5lib.callbacks;
-//Information class for link callback(for H5Pcreate_class)
+/**
+ * Information class for link callback for H5Pcreate_class.
+ *
+ */
public interface H5P_cls_close_func_cb extends Callbacks {
+ /**
+ * application callback for each property list
+ *
+ * @param prop_id the ID for the property list class being iterated over
+ * @param close_data the function to call when a property list is closed
+ *
+ * @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(long prop_id, H5P_cls_close_func_t close_data);
}