diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 847d38d1c9..4b2bd03848 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -342,7 +342,8 @@ END SUBROUTINE h5gcreate_f The comment is returned in the buffer comment.

At most bufsize characters, including a null - terminator, are copied. The result is not null terminated + terminator, are returned in comment. + The returned value is not null terminated if the comment is longer than the supplied buffer.

If an object does not have a comment, the empty string @@ -356,14 +357,14 @@ END SUBROUTINE h5gcreate_f is to be retreived.
name can be '.' (dot) if loc_id - fully specifies the object for which the associated comment + fully specifies the object for which the associated comment is to be retrieved.
name is ignored if loc_id is a dataset or named datatype.

size_t bufsize -
IN: Anticipated size of the buffer required to hold - comment. +
IN: Anticipated required size of the + comment buffer.
char *comment
OUT: The comment. @@ -377,10 +378,10 @@ END SUBROUTINE h5gcreate_f
 SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: loc_id         ! File or group identifier
+  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 a
-                                               ! comment  
+  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
@@ -1282,8 +1283,9 @@ END SUBROUTINE h5gopen_f
   
Purpose:
Sets comment for specified object.
Description: -
H5Gset_comment sets the comment for the the - object name to comment. +
H5Gset_comment sets the comment for the + object specified by loc_id and name + to comment. Any previously existing comment is overwritten.

If comment is the empty string or a @@ -1293,14 +1295,20 @@ END SUBROUTINE h5gopen_f ASCII strings.

Comments can be attached to any object that has an object header, - e.g., data sets, groups, named data types, and data spaces, but + e.g., datasets, groups, named datatypes, and dataspaces, but not symbolic links.

Parameters:
hid_t loc_id -
IN: Identifier of the file or group. +
IN: Identifier of the file, group, dataset, or named datatype.
const char *name
IN: Name of the object whose comment is to be set or reset. +
+ name can be '.' (dot) if loc_id + fully specifies the object for which the comment is to be set. +
+ name is ignored if loc_id + is a dataset or named datatype.
const char *comment
IN: The new comment.
@@ -1312,7 +1320,8 @@ END SUBROUTINE h5gopen_f
 SUBROUTINE h5gset_comment_f(loc_id, name, comment, hdferr)
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: loc_id      ! File or group identifier
+  INTEGER(HID_T), INTENT(IN) :: loc_id      ! File, group, dataset, or 
+                                            ! named datatype identifier
   CHARACTER(LEN=*), INTENT(IN) :: name      ! Name of object 
   CHARACTER(LEN=*), INTENT(IN) :: comment   ! Comment for the object 
   INTEGER, INTENT(OUT) :: hdferr            ! Error code 
@@ -1436,7 +1445,7 @@ And in this document, the
 Describes HDF5 Release 1.6.2, February 2004