diff options
Diffstat (limited to 'src/H5Gpublic.h')
| -rw-r--r-- | src/H5Gpublic.h | 132 |
1 files changed, 129 insertions, 3 deletions
diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h index e46bef6..26617d3 100644 --- a/src/H5Gpublic.h +++ b/src/H5Gpublic.h @@ -118,6 +118,28 @@ extern "C" { * */ H5_DLL hid_t H5Gcreate2(hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5G + * + * \brief Asynchronous version of H5Gcreate2() + * + * \app_file + * \app_func + * \app_line + * \fgdta_loc_id + * \param[in] name Name of the group to create + * \lcpl_id + * \gcpl_id + * \gapl_id + * \es_id + * + * \return \hid_t{group} + * + * \see H5Gcreate2() + * + */ H5_DLL hid_t H5Gcreate_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id, hid_t es_id); @@ -199,6 +221,26 @@ H5_DLL hid_t H5Gcreate_anon(hid_t loc_id, hid_t gcpl_id, hid_t gapl_id); * */ H5_DLL hid_t H5Gopen2(hid_t loc_id, const char *name, hid_t gapl_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5G + * + * \brief Asynchronous version of H5Gopen2() + * + * \app_file + * \app_func + * \app_line + * \fgdta_loc_id + * \param[in] name Name of the group to open + * \gapl_id + * \es_id + * + * \return \hid_t{group} + * + * \see H5Gopen2() + * + */ H5_DLL hid_t H5Gopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, const char *name, hid_t gapl_id, hid_t es_id); @@ -253,8 +295,26 @@ H5_DLL hid_t H5Gget_create_plist(hid_t group_id); */ H5_DLL herr_t H5Gget_info(hid_t loc_id, H5G_info_t *ginfo); +/** + * -------------------------------------------------------------------------- + * \ingroup H5G + * + * \brief Asynchronous version of H5Gget_info() + * + * \app_file + * \app_func + * \app_line + * \fgdta_loc_id + * \param[out] ginfo Struct in which group information is returned + * \es_id + * + * \return \hid_t{group} + * + * \see H5Gget_info() + * + */ H5_DLL herr_t H5Gget_info_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, - H5G_info_t *group_info /*out*/, hid_t es_id); + H5G_info_t *ginfo /*out*/, hid_t es_id); /** *------------------------------------------------------------------------- @@ -289,8 +349,29 @@ H5_DLL herr_t H5Gget_info_async(const char *app_file, const char *app_func, unsi * */ H5_DLL herr_t H5Gget_info_by_name(hid_t loc_id, const char *name, H5G_info_t *ginfo, hid_t lapl_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5G + * + * \brief Asynchronous version of H5Gget_info_by_name() + * + * \app_file + * \app_func + * \app_line + * \fgdta_loc_id + * \param[in] name Name of the group to query + * \param[out] ginfo Struct in which group information is returned + * \lapl_id + * \es_id + * + * \return \herr_t + * + * \see H5Gget_info_by_name() + * + */ H5_DLL herr_t H5Gget_info_by_name_async(const char *app_file, const char *app_func, unsigned app_line, - hid_t loc_id, const char *name, H5G_info_t *group_info /*out*/, + hid_t loc_id, const char *name, H5G_info_t *ginfo /*out*/, hid_t lapl_id, hid_t es_id); /** @@ -340,9 +421,36 @@ H5_DLL herr_t H5Gget_info_by_name_async(const char *app_file, const char *app_fu */ H5_DLL herr_t H5Gget_info_by_idx(hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t n, H5G_info_t *ginfo, hid_t lapl_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5G + * + * \brief Asynchronous version of H5Gcreate2() + * + * \app_file + * \app_func + * \app_line + * \fgdta_loc_id + * \param[in] group_name Name of the group to query + * \param[in] idx_type Transient index identifying object + * \param[in] order Transient index identifying object + * \param[in] n Position in the index of the group to query + * \param[out] ginfo Struct in which group information is returned + * \lapl_id + * \es_id + * + * \return Returns + * \li The size of the object name if successful, or + * \li 0 if no name is associated with the group identifier, or + * \li negative value, if failure occurred + * + * \see H5Gcreate2() + * + */ H5_DLL herr_t H5Gget_info_by_idx_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, const char *group_name, H5_index_t idx_type, - H5_iter_order_t order, hsize_t n, H5G_info_t *group_info /*out*/, + H5_iter_order_t order, hsize_t n, H5G_info_t *ginfo /*out*/, hid_t lapl_id, hid_t es_id); /** @@ -422,6 +530,24 @@ H5_DLL herr_t H5Grefresh(hid_t group_id); * */ H5_DLL herr_t H5Gclose(hid_t group_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5G + * + * \brief Asynchronous version of H5Gcreate2() + * + * \app_file + * \app_func + * \app_line + * \group_id + * \es_id + * + * \return \herr_t + * + * \see H5Gcreate2() + * + */ H5_DLL herr_t H5Gclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t group_id, hid_t es_id); |