Sets comment for specified object
H5O_SET_COMMENT(object_id, comment)
herr_t H5Oset_comment( hid_t object_id, const char *comment )
SUBROUTINE h5oset_comment_f(obj_id, comment, hdferr)
IMPLICIT NONE
INTEGER(HID_T) , INTENT(IN) :: obj_id
CHARACTER(LEN=*), INTENT(IN) :: comment
INTEGER , INTENT(OUT) :: hdferr
hid_t object_id | IN: Identifier of the target object; may be a file, group, dataset, named datatype or attribute identifier |
const char *comment | IN: The new comment |
H5O_SET_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. 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.
Returns a non-negative value if successful; otherwise returns a negative value.
| Release | Change |
|---|
| 1.8.11 | Fortran subroutine introduced in this release. |
| 1.8.0 | Function introduced in this release. |
--- Last Modified: April 25, 2019 | 01:29 PM
