summaryrefslogtreecommitdiffstats
path: root/src/H5Dpublic.h
diff options
context:
space:
mode:
authorMark Kittisopikul <mkitti@users.noreply.github.com>2022-08-07 04:57:41 (GMT)
committerGitHub <noreply@github.com>2022-08-07 04:57:41 (GMT)
commit7127d8912c8fa601d59b4e8ce522eaf149c02344 (patch)
treeb83c86f9c7af27893d30469d117eeeed8b7756ee /src/H5Dpublic.h
parent043f66afd22c329104813b61a789af862e5349ac (diff)
downloadhdf5-7127d8912c8fa601d59b4e8ce522eaf149c02344.zip
hdf5-7127d8912c8fa601d59b4e8ce522eaf149c02344.tar.gz
hdf5-7127d8912c8fa601d59b4e8ce522eaf149c02344.tar.bz2
H5Dchunk_iter now passes offsets in units of dataset elements, fix #1419 (#1969)
* H5Dchunk_iter now passes chunk dimension scaled offsets, fix #1419 * Update docs for H5Dchunk_iter, H5Dget_chunk_info* Modified description for `H5Dchunk_iter`, `H5Dget_chunk_info`, and `H5Dget_chunk_info_by_coord` to the following * offset Logical position of the chunk’s first element in units of dataset elements * filter_mask Bitmask indicating the filters used when the chunk was written * size Chunk size in bytes, 0 if the chunk does not exist
Diffstat (limited to 'src/H5Dpublic.h')
-rw-r--r--src/H5Dpublic.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h
index 8bdac8d..8126aff 100644
--- a/src/H5Dpublic.h
+++ b/src/H5Dpublic.h
@@ -226,10 +226,10 @@ typedef herr_t (*H5D_gather_func_t)(const void *dst_buf, size_t dst_buf_bytes_us
/**
* \brief Callback for H5Dchunk_iter()
*
- * \param[in] offset Array of starting logical coordinates of chunk.
- * \param[in] filter_mask Filter mask of chunk.
- * \param[in] addr Offset in file of chunk data.
- * \param[in] nbytes Size in bytes of chunk data in file.
+ * \param[in] offset Logical position of the chunk’s first element in units of dataset elements
+ * \param[in] filter_mask Bitmask indicating the filters used when the chunk was written
+ * \param[in] addr Chunk address in the file
+ * \param[in] size Chunk size in bytes, 0 if the chunk does not exist
* \param[in,out] op_data Pointer to any user-defined data associated with
* the operation.
* \returns \li Zero (#H5_ITER_CONT) causes the iterator to continue, returning
@@ -239,7 +239,7 @@ typedef herr_t (*H5D_gather_func_t)(const void *dst_buf, size_t dst_buf_bytes_us
* \li A negative (#H5_ITER_ERROR) causes the iterator to immediately
* return that value, indicating failure.
*/
-typedef int (*H5D_chunk_iter_op_t)(const hsize_t *offset, uint32_t filter_mask, haddr_t addr, uint32_t nbytes,
+typedef int (*H5D_chunk_iter_op_t)(const hsize_t *offset, uint32_t filter_mask, haddr_t addr, uint32_t size,
void *op_data);
//! <!-- [H5D_chunk_iter_op_t_snip] -->
@@ -634,10 +634,10 @@ H5_DLL herr_t H5Dget_num_chunks(hid_t dset_id, hid_t fspace_id, hsize_t *nchunks
* \brief Retrieves information about a chunk specified by its coordinates
*
* \dset_id
- * \param[in] offset Logical position of the chunk’s first element
- * \param[out] filter_mask Indicating filters used with the chunk when written
+ * \param[in] offset Logical position of the chunk’s first element in units of dataset elements
+ * \param[out] filter_mask Bitmask indicating the filters used when the chunk was written
* \param[out] addr Chunk address in the file
- * \param[out] size Chunk size in bytes, 0 if chunk doesn’t exist
+ * \param[out] size Chunk size in bytes, 0 if the chunk does not exist
*
* \return \herr_t
*
@@ -672,7 +672,7 @@ H5_DLL herr_t H5Dget_chunk_info_by_coord(hid_t dset_id, const hsize_t *offset, u
*
* \return \herr_t
*
- * \details H5Dget_chunk_iter iterates over all chunks in the dataset, calling the
+ * \details H5Dchunk_iter iterates over all chunks in the dataset, calling the
* user supplied callback with the details of the chunk and the supplied
* context \p op_data.
*
@@ -696,10 +696,10 @@ H5_DLL herr_t H5Dchunk_iter(hid_t dset_id, hid_t dxpl_id, H5D_chunk_iter_op_t cb
* \dset_id
* \param[in] fspace_id File dataspace selection identifier (See Note below)
* \param[in] chk_idx Index of the chunk
- * \param[out] offset Logical position of the chunk’s first element
- * \param[out] filter_mask Indicating filters used with the chunk when written
+ * \param[out] offset Logical position of the chunk’s first element in units of dataset elements
+ * \param[out] filter_mask Bitmask indicating the filters used when the chunk was written
* \param[out] addr Chunk address in the file
- * \param[out] size Chunk size in bytes, 0 if chunk doesn’t exist
+ * \param[out] size Chunk size in bytes, 0 if the chunk does not exist
*
* \return \herr_t
*