IN: Location identifier; may be a file, group, dataset, named datatype or attribute identifier
const char *name
IN: Name of the object whose comment is to be set or reset, specified as a path relative toloc_id namecan be '.' (a dot) ifloc_idfully specifies the object for which the comment is to be set.
const char *comment
IN: The new comment
IN: Link access property list identifier
H5O_SET_COMMENT_BY_NAMEsets the comment for the specified object to the contents ofcomment. Any previously existing comment is overwritten.
The target object is specified byloc_idandname.loc_idcan specify any object in the file.namecan be one of the following: — The name of the object relative toloc_id — An absolute name of the object, starting from/, the file’s root group — A dot (.), ifloc_idfully specifies the object
Ifcommentis 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. Datasets, groups, and committed (named) datatypes have object headers. Symbolic links do not have object headers.
If a comment is being added to an object attribute, this comment will be attached to the object to which the attribute belongs and not to the attribute itself.
lapl_idcontains a link access property list identifier. A link access property list can come into play when traversing links to access an object.
Returns a non-negative value if successful; otherwise returns a negative value.