Skip to content

Commit

Permalink
Document H5Punregister modifying default properties (#4570)
Browse files Browse the repository at this point in the history
  • Loading branch information
mattjala authored Jun 15, 2024
1 parent ce99ebc commit 2fa630c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
8 changes: 5 additions & 3 deletions src/H5P.c
Original file line number Diff line number Diff line change
Expand Up @@ -1397,8 +1397,10 @@ H5Pcopy_prop(hid_t dst_id, hid_t src_id, const char *name)
Returns non-negative on success, negative on failure.
DESCRIPTION
Removes a property from a property list class. Future property lists
created of that class will not contain this property. Existing property
lists containing this property are not affected.
created of that class will not contain this property. Existing property lists
which still use the default value for this property will have this property removed.
Existing property lists which have modified this property will not be affected.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Expand All @@ -1419,7 +1421,7 @@ H5Punregister(hid_t pclass_id, const char *name)
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");

/* Remove the property list from class */
/* Remove the property from property list class */
if ((ret_value = H5P__unregister(pclass, name)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to remove property from class");

Expand Down
4 changes: 2 additions & 2 deletions src/H5Ppkg.h
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,10 @@ struct H5P_genclass_t {
struct H5P_genplist_t {
H5P_genclass_t *pclass; /* Pointer to class info */
hid_t plist_id; /* Copy of the property list ID (for use in close callback) */
size_t nprops; /* Number of properties in class */
size_t nprops; /* Number of properties in this list */
bool class_init; /* Whether the class initialization callback finished successfully */
H5SL_t *del; /* Skip list containing names of deleted properties */
H5SL_t *props; /* Skip list containing properties */
H5SL_t *props; /* Skip list containing properties modified from the parent class */
};

/* Property list/class iterator callback function pointer */
Expand Down

0 comments on commit 2fa630c

Please sign in to comment.