summaryrefslogtreecommitdiffstats
path: root/src/H5FDonion.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/H5FDonion.h')
-rw-r--r--src/H5FDonion.h53
1 files changed, 52 insertions, 1 deletions
diff --git a/src/H5FDonion.h b/src/H5FDonion.h
index 0e45b80..bca6526 100644
--- a/src/H5FDonion.h
+++ b/src/H5FDonion.h
@@ -128,10 +128,61 @@ typedef struct H5FD_onion_fapl_info_t {
extern "C" {
#endif
-H5_DLL hid_t H5FD_onion_init(void);
+H5_DLL hid_t H5FD_onion_init(void);
+
+/**
+ * --------------------------------------------------------------------------
+ * \ingroup H5P
+ *
+ * \brief get the onion info from the file access property list
+ *
+ * \param[in] fapl_id The ID of the file access property list
+ * \param[out] fa_out The pointer to the structure H5FD_onion_fapl_info_t
+ *
+ * \return \herr_t
+ *
+ * \details H5Pget_fapl_onion() retrieves the structure H5FD_onion_fapl_info_t
+ * from the file access property list that is set for the onion VFD
+ * driver.
+ */
H5_DLL herr_t H5Pget_fapl_onion(hid_t fapl_id, H5FD_onion_fapl_info_t *fa_out);
+
+/**
+ * --------------------------------------------------------------------------
+ * \ingroup H5P
+ *
+ * \brief set the onion info for the file access property list
+ *
+ * \param[in] fapl_id The ID of the file access property list
+ * \param[in] fa The pointer to the structure H5FD_onion_fapl_info_t
+ *
+ * \return \herr_t
+ *
+ * \details H5Pset_fapl_onion() sets the structure H5FD_onion_fapl_info_t
+ * for the file access property list that is set for the onion VFD
+ * driver.
+ */
H5_DLL herr_t H5Pset_fapl_onion(hid_t fapl_id, const H5FD_onion_fapl_info_t *fa);
+/**
+ * --------------------------------------------------------------------------
+ * \ingroup H5FD
+ *
+ * \brief get the number of revisions
+ *
+ * \param[in] filename The name of the onion file
+ * \param[in] fapl_id The ID of the file access property list
+ * \param[out] revision_count The number of revisions
+ *
+ * \return \herr_t
+ *
+ * \details H5FDget_onion_revision_count() returns the number of revisions
+ * for an onion file. It takes the file name and file access property
+ * list that is set for the onion VFD driver.
+ *
+ */
+H5_DLL herr_t H5FDget_onion_revision_count(const char *filename, hid_t fapl_id, size_t *revision_count);
+
#ifdef __cplusplus
}
#endif