diff options
Diffstat (limited to 'src/H5Ipublic.h')
| -rw-r--r-- | src/H5Ipublic.h | 30 |
1 files changed, 27 insertions, 3 deletions
diff --git a/src/H5Ipublic.h b/src/H5Ipublic.h index ce78ae3..3e429ec 100644 --- a/src/H5Ipublic.h +++ b/src/H5Ipublic.h @@ -125,6 +125,8 @@ extern "C" { * will be a reference to. This pointer will be stored by the library * and returned via a call to H5Iobject_verify(). * + * \since 1.8.0 + * */ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object); /** @@ -148,6 +150,8 @@ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object); * * \see H5Iregister() * + * \since 1.8.0 + * */ H5_DLL void *H5Iobject_verify(hid_t id, H5I_type_t type); /** @@ -178,6 +182,8 @@ H5_DLL void *H5Iobject_verify(hid_t id, H5I_type_t type); * The pointer returned by H5Iregister() must be deallocated by the user * to avoid memory leaks. * + * \since 1.8.0 + * */ H5_DLL void *H5Iremove_verify(hid_t id, H5I_type_t type); /** @@ -202,6 +208,8 @@ H5_DLL void *H5Iremove_verify(hid_t id, H5I_type_t type); * is valid identifier. Validity can be determined with a call to * H5Iis_valid(). * + * \since 1.0.0 + * */ H5_DLL H5I_type_t H5Iget_type(hid_t id); /** @@ -311,7 +319,7 @@ H5_DLL ssize_t H5Iget_name(hid_t id, char *name /*out*/, size_t size); * safely closed or decremented and the HDF5 object will be closed * when the reference count for that that object drops to zero. * - * \since 1.6.2 + * \since 1.6.3 * */ H5_DLL int H5Iinc_ref(hid_t id); @@ -357,7 +365,7 @@ H5_DLL int H5Iinc_ref(hid_t id); * safely closed or decremented and the HDF5 object will be closed * when the reference count for that object drops to zero. * - * \since 1.6.2 + * \since 1.6.3 * */ H5_DLL int H5Idec_ref(hid_t id); @@ -381,7 +389,7 @@ H5_DLL int H5Idec_ref(hid_t id); * The function H5Iis_valid() is used to determine whether a specific * object identifier is valid. * - * \since 1.6.2 + * \since 1.6.3 * */ H5_DLL int H5Iget_ref(hid_t id); @@ -415,6 +423,8 @@ H5_DLL int H5Iget_ref(hid_t id); * pointer which was passed in to the H5Iregister() function. The \p * free_func function should return 0 on success and -1 on failure. * + * \since 1.8.0 + * */ H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free_t free_func); /** @@ -439,6 +449,8 @@ H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free * identifiers will be entirely unchanged. If the force flag is true, * all identifiers of this type will be deleted. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force); /** @@ -462,6 +474,8 @@ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force); * reused when new types are registered, it is a good idea to set the * variable holding the value of the destroyed type to #H5I_UNINIT. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Idestroy_type(H5I_type_t type); /** @@ -481,6 +495,8 @@ H5_DLL herr_t H5Idestroy_type(H5I_type_t type); * reference count is to be incremented. This identifier must have * been created by a call to H5Iregister_type(). * + * \since 1.8.0 + * */ H5_DLL int H5Iinc_type_ref(H5I_type_t type); /** @@ -501,6 +517,8 @@ H5_DLL int H5Iinc_type_ref(H5I_type_t type); * reference count is to be decremented. This identifier must have * been created by a call to H5Iregister_type(). * + * \since 1.8.0 + * */ H5_DLL int H5Idec_type_ref(H5I_type_t type); /** @@ -520,6 +538,8 @@ H5_DLL int H5Idec_type_ref(H5I_type_t type); * reference count is to be retrieved. This identifier must have been * created by a call to H5Iregister_type(). * + * \since 1.8.0 + * */ H5_DLL int H5Iget_type_ref(H5I_type_t type); /** @@ -561,6 +581,8 @@ H5_DLL int H5Iget_type_ref(H5I_type_t type); * The \p key parameter will be passed to the search function as a * parameter. It can be used to further define the search at run-time. * + * \since 1.8.0 + * */ H5_DLL void *H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key); /** @@ -613,6 +635,8 @@ H5_DLL herr_t H5Iiterate(H5I_type_t type, H5I_iterate_func_t op, void *op_data); * exist, or it has been destroyed, \p num_members is returned with * the value 0. * + * \since 1.8.0 + * */ H5_DLL herr_t H5Inmembers(H5I_type_t type, hsize_t *num_members); /** |