[svn-r8087]

Purpose:
    Correct H5G_stat_t struct description in H5Gget_objinfo
    Copy edits
Platforms tested:
    Safari, IE 5
This commit is contained in:
Frank Baker 2004-01-22 16:10:24 -05:00
parent 7f5fd94b56
commit cc3b64b1e9

View File

@ -469,7 +469,7 @@ END SUBROUTINE h5gget_linkval_f
<dt><strong>Description:</strong> <dt><strong>Description:</strong>
<dd><code>H5Gget_num_objs</code> returns number of objects in a group. <dd><code>H5Gget_num_objs</code> returns number of objects in a group.
Group is specified by its identifier <code>loc_id</code>. Group is specified by its identifier <code>loc_id</code>.
If a file identifier is passed in, then number of objects in the If a file identifier is passed in, then the number of objects in the
root group is returned. root group is returned.
<dt><strong>Parameters:</strong> <dt><strong>Parameters:</strong>
<dl> <dl>
@ -532,13 +532,14 @@ SUBROUTINE
unsigned long fileno; unsigned long fileno;
haddr_t objno; haddr_t objno;
unsigned nlink; unsigned nlink;
int type; H5G_obj_t type;
time_t mtime; time_t mtime;
size_t linklen; size_t linklen;
H5O_stat_t ohdr;
} H5G_stat_t } H5G_stat_t
</pre> </pre>
The <code>fileno</code> and <code>objno</code> fields contain The <code>fileno</code> and <code>objno</code> fields contain
values which uniquely itentify an object among those values which uniquely identify an object among those
HDF5 files which are open: if both values are the same HDF5 files which are open: if both values are the same
between two objects, then the two objects are the same between two objects, then the two objects are the same
(provided both files are still open). (provided both files are still open).
@ -566,6 +567,9 @@ SUBROUTINE
<code>linklen</code> will be the length of the link value <code>linklen</code> will be the length of the link value
(the name of the pointed-to object with the null terminator); (the name of the pointed-to object with the null terminator);
otherwise <code>linklen</code> will be zero. otherwise <code>linklen</code> will be zero.
<!-- INSERT H50_stat_t DESCRIPTION AS IN 1.6 -->
Other fields may be added to this structure in the future. Other fields may be added to this structure in the future.
<dt><strong>Note:</strong> <dt><strong>Note:</strong>
<dd>Some systems will be able to record the time accurately but <dd>Some systems will be able to record the time accurately but
@ -1402,7 +1406,7 @@ And in this document, the
Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT"> </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
<!-- <!--
document.writeln("Last modified: 29 October 2003"); document.writeln("Last modified: 22 January 2004");
--> -->
</SCRIPT> </SCRIPT>