H5Gget_comment(hid_t loc_id,
const char *name,
size_t bufsize,
char *comment
)
H5Oget_comment.
H5Gget_comment retrieves the comment for the the
object specified by loc_id and name.
The comment is returned in the buffer comment.
loc_id can specify any object in the file.
name can be one of the following:
— The name of the object relative to
loc_id
— An absolute name of the object,
starting from /, the file’s root group
— A dot (.),
if loc_id fully specifies the object
At most bufsize characters, including a null
terminator, are returned in comment.
The returned value is not null terminated
if the comment is longer than the supplied buffer.
If the size of the comment is unknown, a preliminary
H5Gget_comment call will return the size of the
comment, including space for the null terminator.
If an object does not have a comment, the empty string
is returned in comment.
hid_t loc_id |
IN: Identifier of the file, group, dataset, or named datatype. |
const char *name |
IN: Name of the object in loc_id whose
comment is to be retrieved.
name must be '.' (dot) if loc_id
fully specifies the object for which the associated comment
is to be retrieved.
|
size_t bufsize |
IN: Anticipated required size of the
comment buffer. |
char *comment |
OUT: The comment. |
bufsize.
Otherwise returns a negative value.
SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
IMPLICIT NONE
INTEGER(HID_T), INTENT(IN) :: loc_id ! File, group, dataset, or
! named datatype identifier
CHARACTER(LEN=*), INTENT(IN) :: name ! Name of the object link
CHARACTER(LEN=size), INTENT(OUT) :: buffer ! Buffer to hold the comment
INTEGER, INTENT(OUT) :: hdferr ! Error code
! 0 on success and -1 on failure
END SUBROUTINE h5gget_comment_f
| Release | C |
| 1.8.0 | Function deprecated in this release. |