H5Oset_comment
(
hid_t object_id
,
const char *comment
)
H5Oset_comment
sets the comment for
the specified object to the contents of comment
.
Any previously existing comment is overwritten.
The target object is specified by an identifier, object_id
.
If comment
is the empty string or a
null pointer, any existing comment message is removed from the object.
Comments should be relatively short, null-terminated, ASCII strings.
Comments can be attached to any object that has an object header, e.g., datasets, groups, and named datatypes, but not symbolic links.
hid_t object_id |
IN: Identifier of the target object |
const char *comment |
IN: The new comment. |
Release | C |
1.8.0 | Function introduced in this release. |