diff options
Diffstat (limited to 'doc/src/RM_H5G.html')
| -rw-r--r-- | doc/src/RM_H5G.html | 33 |
1 files changed, 25 insertions, 8 deletions
diff --git a/doc/src/RM_H5G.html b/doc/src/RM_H5G.html index 178737b..634d071 100644 --- a/doc/src/RM_H5G.html +++ b/doc/src/RM_H5G.html @@ -18,7 +18,10 @@ H5G <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -50,7 +53,7 @@ of objects on disk. </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Group-Stat">H5Gstat</a> + <li><a href="#Group-Stat">H5Gget_stat</a> <li><a href="#Group-GetLinkval">H5Gget_linkval</a> <li><a href="#Group-SetComment">H5Gset_comment</a> <li><a href="#Group-GetComment">H5Gget_comment</a> @@ -503,9 +506,9 @@ then be trivial. <hr> <dl> - <dt><strong>Name:</strong> <a name="Group-Stat">H5Gstat</a> + <dt><strong>Name:</strong> <a name="Group-Stat">H5Gget_stat</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Gstat</code>(<em>hid_t</em> <code>loc_id</code>, + <dd><em>herr_t</em> <code>H5Gget_stat</code>(<em>hid_t</em> <code>loc_id</code>, <em>const char *</em><code>name</code>, <em>hbool_t</em> <code>follow_link</code>, <em>H5G_stat_t *</em><code>statbuf</code> @@ -513,7 +516,7 @@ then be trivial. <dt><strong>Purpose:</strong> <dd>Returns information about an object. <dt><strong>Description:</strong> - <dd><code>H5Gstat</code> returns information about the + <dd><code>H5Gget_stat</code> returns information about the specified object through the <code>statbuf</code> argument. <code>loc_id</code> (a file, group, or dataset identifier) and <code>name</code> together determine the object. @@ -527,13 +530,14 @@ then be trivial. The existence of an object can be tested by calling this function with a null <code>statbuf</code>. <p> - <code>H5Gstat()</code> fills in the following data structure: + <code>H5Gget_stat()</code> fills in the following data structure: <pre> typedef struct H5G_stat_t { unsigned long fileno[2]; unsigned long objno[2]; unsigned nlink; H5G_type_t type; + time_t mtime; size_t linklen; } H5G_stat_t </pre> @@ -549,11 +553,16 @@ then be trivial. The <code>type</code> field contains the type of the object, one of <code>H5G_GROUP</code>, <code>H5G_DATASET</code>, or <code>H5G_LINK</code>. + The <code>mtime</code> field contains the modification time. If information is being returned about a symbolic link then <code>linklen</code> will be the length of the link value (the name of the pointed-to object with the null terminator); otherwise <code>linklen</code> will be zero. Other fields may be added to this structure in the future. + <dt><strong>Note:</strong> + <dd>Some systems will be able to record the time accurately but + unable to retrieve the correct time; such systems (e.g., Irix64) + will report an <code>mtime</code> value of 0 (zero). <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> @@ -566,7 +575,8 @@ then be trivial. <dd>OUT: Buffer in which to return information about the object. </dl> <dt><strong>Returns:</strong> - <dd> Returns SUCCEED (0) with the fields of STATBUF (if non-null) initialized. + <dd> Returns SUCCEED (0) with the fields of <code>statbuf</code> + (if non-null) initialized. Otherwise returns FAIL (-1). </dl> @@ -594,7 +604,7 @@ then be trivial. The presence of a symbolic link can be tested by passing zero for <code>size</code> and NULL for <code>value</code>. <p> - Use <code>H5Gstat()</code> to get the size of a link value. + Use <code>H5Gget_stat()</code> to get the size of a link value. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> @@ -638,6 +648,10 @@ then be trivial. <p> Comments should be relatively short, null-terminated, ASCII strings. + <p> + Comments can be attached to any object that has an object header, + e.g., data sets, groups, named data types, and data spaces, but + not symbolic links. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> @@ -713,7 +727,10 @@ H5G <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -721,7 +738,7 @@ H5G <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 2 September 1998 </body> </html> |