diff options
author | Dana Robinson <derobins@hdfgroup.org> | 2021-05-03 21:55:26 (GMT) |
---|---|---|
committer | Dana Robinson <derobins@hdfgroup.org> | 2021-05-03 21:55:26 (GMT) |
commit | 0ab5dd5e8ea2342ef039f0f79bd76e4ab187dddf (patch) | |
tree | 6900490d46d768f991e7cc91d45d4f8dc17985a4 /src/H5FDfamily.h | |
parent | fca509b7d61b9dffae85be3406ca484c1bf28242 (diff) | |
download | hdf5-0ab5dd5e8ea2342ef039f0f79bd76e4ab187dddf.zip hdf5-0ab5dd5e8ea2342ef039f0f79bd76e4ab187dddf.tar.gz hdf5-0ab5dd5e8ea2342ef039f0f79bd76e4ab187dddf.tar.bz2 |
Brings more develop code over, especially Doxygen
Diffstat (limited to 'src/H5FDfamily.h')
-rw-r--r-- | src/H5FDfamily.h | 52 |
1 files changed, 51 insertions, 1 deletions
diff --git a/src/H5FDfamily.h b/src/H5FDfamily.h index f00836f..20ef532 100644 --- a/src/H5FDfamily.h +++ b/src/H5FDfamily.h @@ -26,8 +26,58 @@ extern "C" { #endif -H5_DLL hid_t H5FD_family_init(void); +H5_DLL hid_t H5FD_family_init(void); + +/** + * \ingroup FAPL + * + * \brief Sets the file access property list to use the family driver + * + * \fapl_id + * \param[in] memb_size Size in bytes of each file member + * \param[in] memb_fapl_id Identifier of file access property list for + * each family member + * \returns \herr_t + * + * \details H5Pset_fapl_family() sets the file access property list identifier, + * \p fapl_id, to use the family driver. + * + * \p memb_size is the size in bytes of each file member. This size + * will be saved in file when the property list \p fapl_id is used to + * create a new file. If \p fapl_id is used to open an existing file, + * \p memb_size has to be equal to the original size saved in file. A + * failure with an error message indicating the correct member size + * will be returned if \p memb_size does not match the size saved. If + * any user does not know the original size, #H5F_FAMILY_DEFAULT can be + * passed in. The library will retrieve the saved size. + * + * \p memb_fapl_id is the identifier of the file access property list + * to be used for each family member. + * + * \version 1.8.0 Behavior of the \p memb_size parameter was changed. + * \since 1.4.0 + * + */ H5_DLL herr_t H5Pset_fapl_family(hid_t fapl_id, hsize_t memb_size, hid_t memb_fapl_id); + +/** + * \ingroup FAPL + * + * \brief Returns file access property list information + * + * \fapl_id + * \param[out] memb_size Size in bytes of each file member + * \param[out] memb_fapl_id Identifier of file access property list for + * each family member + * \returns \herr_t + * + * \details H5Pget_fapl_family() returns file access property list for use with + * the family driver. This information is returned through the output + * parameters. + * + * \since 1.4.0 + * + */ H5_DLL herr_t H5Pget_fapl_family(hid_t fapl_id, hsize_t *memb_size /*out*/, hid_t *memb_fapl_id /*out*/); #ifdef __cplusplus |