diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 2004-05-21 21:12:30 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 2004-05-21 21:12:30 (GMT) |
| commit | d6845ab65582bcea1986830aa5b23d7fc295149c (patch) | |
| tree | f9ebdf0229b8acf8e01f334d4d350befabf16159 /doc | |
| parent | 3e56e3d7f927f530c6ef2d506e4f4a745dcbcb1a (diff) | |
| download | hdf5-d6845ab65582bcea1986830aa5b23d7fc295149c.zip hdf5-d6845ab65582bcea1986830aa5b23d7fc295149c.tar.gz hdf5-d6845ab65582bcea1986830aa5b23d7fc295149c.tar.bz2 | |
[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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/RM_H5G.html | 34 |
1 files 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 <dd>Retrieves comment for specified object. <dt><strong>Description:</strong> <dd><code>H5Gget_comment</code> retrieves the comment for the the - object <code>name</code>. The comment is returned in the buffer - <code>comment</code>. + object specified by <code>loc_id</code> and <code>name</code>. + The comment is returned in the buffer <code>comment</code>. <p> At most <code>bufsize</code> characters, including a null terminator, are copied. The result is not null terminated @@ -353,17 +353,27 @@ END SUBROUTINE h5gcreate_f <dt><strong>Parameters:</strong> <ul><table> <tr> - <td valign="top"><em>hid_t</em> <code>loc_id</code></td> + <td valign="top"><em>hid_t</em> <code>loc_id</code></td> <td valign="top">IN: Identifier of the file or group.</td></tr> <tr> - <td valign="top"><em>const char *</em><code>name </code></td> - <td valign="top">IN: Name of the object whose comment is to be set or reset.</td></tr> + <td valign="top"><em>const char *</em><code>name </code></td> + <td valign="top">IN: Name of the object in <code>loc_id</code> whose + comment is to be retrieved. + <br> + <code>name</code> can be '.' (dot) if <code>loc_id</code> + fully specifies the object for which the associated comment + is to be retrieved. + <br> + <code>name</code> is ignored if <code>loc_id</code> + is a dataset or named datatype. + + </td></tr> <tr> - <td valign="top"><em>size_t</em> <code>bufsize</code></td> + <td valign="top"><em>size_t</em> <code>bufsize</code></td> <td valign="top">IN: Anticipated size of the buffer required to hold <code>comment</code>.</td></tr> <tr> - <td valign="top"><em>char *</em><code>comment</code></td> + <td valign="top"><em>char *</em><code>comment</code></td> <td valign="top">OUT: The comment.</td></tr> </table></ul> <dt><strong>Returns:</strong> @@ -373,7 +383,7 @@ END SUBROUTINE h5gcreate_f Otherwise returns a negative value. <dt><strong>Fortran90 Interface:</strong> h5gget_comment_f <dd> - <pre> + <pre> 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 - </pre> - - <!--<dt><strong>Non-C API(s):</strong> + </pre> + + <!--<dt><strong>Non-C API(s):</strong> <dd> <img src="Graphics/Java.gif"> @@ -1453,7 +1463,7 @@ And in this document, the Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> <!-- -document.writeln("Last modified: 24 February 2004"); +document.writeln("Last modified: 21 May 2004"); --> </SCRIPT> |