summaryrefslogtreecommitdiffstats
path: root/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java
diff options
context:
space:
mode:
Diffstat (limited to 'java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java')
-rw-r--r--java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java23
1 files changed, 21 insertions, 2 deletions
diff --git a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java
index a163f11..cf7ada6 100644
--- a/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java
+++ b/java/src/hdf/hdf5lib/callbacks/H5D_append_cb.java
@@ -1,6 +1,5 @@
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
- * Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
@@ -13,7 +12,27 @@
package hdf.hdf5lib.callbacks;
-//Information class for link callback(for H5Pset/get_append_flush)
+/**
+ * Information class for link callback for H5Pset/get_append_flush.
+ *
+ */
public interface H5D_append_cb extends Callbacks {
+ /**
+ * application callback for each dataset access property list
+ *
+ * @param dataset_id the ID for the dataset being iterated over
+ * @param cur_dims the dimension sizes for determining boundary
+ * @param op_data the operator data passed in to H5Pset/get_append_flush
+ *
+ * @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 dataset_id, long[] cur_dims, H5D_append_t op_data);
}