From d6845ab65582bcea1986830aa5b23d7fc295149c Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Fri, 21 May 2004 16:12:30 -0500 Subject: [svn-r8566] Purpose: H5Gget_comment bugfix Description: H5Gget_comment: Changed "Description" text and "Parameters" descriptions to indicate the following: 'loc_id' can be file, group, dataset, or named datatype. 'name' can be '.' if 'loc_id' fully describes the object. 'name' is ignored if 'loc_id' is a dataset or nemed datatype. Also corrected the fact that the 'name' parameter description referred to setting the comment rather than retriving it. Platforms tested: Safari --- doc/html/RM_H5G.html | 34 ++++++++++++++++++++++------------ 1 file changed, 22 insertions(+), 12 deletions(-) diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 6f2e191..edd91a2 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -341,8 +341,8 @@ END SUBROUTINE h5gcreate_f
Retrieves comment for specified object.
Description:
H5Gget_comment retrieves the comment for the the - object name. The comment is returned in the buffer - comment. + object specified by loc_id and name. + The comment is returned in the buffer comment.

At most bufsize characters, including a null terminator, are copied. The result is not null terminated @@ -353,17 +353,27 @@ END SUBROUTINE h5gcreate_f

Parameters:
Returns: @@ -373,7 +383,7 @@ END SUBROUTINE h5gcreate_f Otherwise returns a negative value.
Fortran90 Interface: h5gget_comment_f
-
+    
 SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
   IMPLICIT NONE
   INTEGER(HID_T), INTENT(IN) :: loc_id         ! File or group identifier
@@ -383,9 +393,9 @@ SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
   INTEGER, INTENT(OUT) :: hdferr               ! Error code 
                                                ! 0 on success and -1 on failure
 END SUBROUTINE h5gget_comment_f
-	
- - -- cgit v0.12