diff options
| author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2021-04-30 19:47:51 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-30 19:47:51 (GMT) |
| commit | 73bb382e9e77ca9847c09dff37b9e2338f26bbb8 (patch) | |
| tree | 85e726e1aae576dc13ac76da36c92305c669ec92 /src/H5Gpublic.h | |
| parent | 7ab97037a0f64a583a6c7d4064d92a963cdfd843 (diff) | |
| download | hdf5-73bb382e9e77ca9847c09dff37b9e2338f26bbb8.zip hdf5-73bb382e9e77ca9847c09dff37b9e2338f26bbb8.tar.gz hdf5-73bb382e9e77ca9847c09dff37b9e2338f26bbb8.tar.bz2 | |
Fixes crashes when size_hint > UINT32_MAX is passed to H5Gcreate1 (#611)
* Committing clang-format changes
* Fixes incorrect size_hint handling in H5Gcreate1
* Updates the size hint type for group creation
* Updates the RELEASE.txt note
* Revert "Updates the RELEASE.txt note"
This reverts commit 3df386acca806d652bbe2209f7c4503b30f068ff.
* Reverts previous behavior to use a uint32_t struct field
* Updates RELEASE.txt
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'src/H5Gpublic.h')
| -rw-r--r-- | src/H5Gpublic.h | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/src/H5Gpublic.h b/src/H5Gpublic.h index 416ff2c..b009d41 100644 --- a/src/H5Gpublic.h +++ b/src/H5Gpublic.h @@ -569,8 +569,8 @@ typedef struct H5G_stat_t { * * \fgdta_loc_id * \param[in] name Name of the group to create - * \param[in] size_hint Optional parameter indicating the number of bytes - * to reserve for the names that will appear in the group + * \param[in] size_hint The number of bytes to reserve for the names + * that will appear in the group * * \return \hid_t{group} * @@ -592,11 +592,9 @@ typedef struct H5G_stat_t { * group, is not limited. * * \p size_hint is a hint for the number of bytes to reserve to store - * the names which will be eventually added to the new group. Passing a - * value of zero for \p size_hint is usually adequate since the library - * is able to dynamically resize the name heap, but a correct hint may - * result in better performance. If a non-positive value is supplied - * for \p size_hint, then a default size is chosen. + * the names which will be eventually added to the new group. This + * value must be between 0 and UINT32_MAX (inclusive). If this + * parameter is zero, a default value will be used. * * The return value is a group identifier for the open group. This * group identifier should be closed by calling H5Gclose() when it is |