diff options
Diffstat (limited to 'doc/html/RM_H5G.html')
| -rw-r--r-- | doc/html/RM_H5G.html | 135 |
1 files changed, 120 insertions, 15 deletions
diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 55b7d5b..9b0a8a0 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/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> @@ -38,20 +41,22 @@ of objects on disk. <li><a href="#Group-Open">H5Gopen</a> <li><a href="#Group-Set">H5Gset</a> <li><a href="#Group-Close">H5Gclose</a> + <li><a href="#Group-Push">H5Gpush</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Group-Push">H5Gpush</a> <li><a href="#Group-Pop">H5Gpop</a> <li><a href="#Group-Link">H5Glink</a> <li><a href="#Group-Unlink">H5Gunlink</a> (NYI) + <li><a href="#Group-Iterate">H5Giterate</a> + <li><a href="#Group-Move">H5Gmove</a> (NYI) </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Group-Iterate">H5Giterate</a> - <li><a href="#Group-Move">H5Gmove</a> (NYI) - <li><a href="#Group-Stat">H5Gstat</a> + <li><a href="#Group-GetObjinfo">H5Gget_objinfo</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> </ul> </td></tr><tr><td colspan=5 align=right> <font size=-2>(NYI = Not yet implemented)</font> @@ -279,7 +284,7 @@ then be trivial. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>The file or group identifier. + <dd>The file, group, dataset, or datatype identifier. </dl> <dt><strong>Returns:</strong> <dd>Returns SUCCEED (0) if successful; @@ -343,7 +348,7 @@ then be trivial. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>File or group identifier. + <dd>File, group, dataset, or datatype identifier. <dt><em>H5G_link_t</em> <code>link_type</code> <dd>Link type. Possible values are <code>H5G_LINK_HARD</code> and <code>H5G_LINK_SOFT</code>. @@ -501,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-GetObjinfo">H5Gget_objinfo</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_objinfo</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> @@ -511,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_objinfo</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. @@ -525,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_objinfo()</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> @@ -547,15 +553,20 @@ 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> - <dd>IN: File, group, or dataset identifier. + <dd>IN: File, group, dataset, or datatype identifier. <dt><em>const char</em> <code>*name</code> <dd>IN: Name of the object for which status is being sought. <dt><em>hbool_t</em> <code>follow_link</code> @@ -564,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> @@ -592,11 +604,11 @@ 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_objinfo()</code> to get the size of a link value. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group . + <dd>IN: Identifier of the file, group, dataset, or datatype. <dt><em>const char *</em><code>name</code> <dd>IN: Name of the object whose link value is to be checked. <dt><em>size_t</em> <code>size</code> @@ -612,6 +624,96 @@ then be trivial. </dl> + + + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Group-SetComment">H5Gset_comment</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Gset_comment</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code>, + <em>const char *</em><code>comment</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets comment for specified object. + <dt><strong>Description:</strong> + <dd><code>H5Gset_comment</code> sets the comment for the the + object <code>name</code> to <code>comment</code>. + Any previously existing comment is overwritten. + <p> + If <code>comment</code> is the empty string or a + null pointer, the comment message is removed from the object. + <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> + <dd>IN: Identifier of the file, group, dataset, or datatype. + <dt><em>const char *</em><code>name</code> + <dd>IN: Name of the object whose comment is to be set or reset. + <dt><em>const char *</em><code>comment</code> + <dd>IN: The new comment. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise returns FAIL (-1). +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Group-GetComment">H5Gget_comment</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Gget_comment</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code>, + <em>size_t</em> <code>bufsize</code>, + <em>char *</em><code>comment</code> + ) + <dt><strong>Purpose:</strong> + <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>. + <p> + At most <code>bufsize</code> characters, including a null + terminator, are copied. The result is not null terminated + if the comment is longer than the supplied buffer. + <p> + If an object does not have a comment, the empty string + is returned. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>loc_id</code> + <dd>IN: Identifier of the file, group, dataset, or datatype. + <dt><em>const char *</em><code>name</code> + <dd>IN: Name of the object whose comment is to be set or reset. + <dt><em>size_t</em> <code>bufsize</code> + <dd>IN: Anticipated size of the buffer required to hold + <code>comment</code>. + <dt><em>char *</em><code>comment</code> + <dd>OUT: The comment. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns the number of characters in the comment, + counting the null terminator, if successful; the value + returned may be larger than <code>bufsize</code>. + Otherwise returns FAIL (-1). +</dl> + + + + + + + <hr> <center> <a href="RM_H5Front.html">HDF5 Reference Manual</a> @@ -625,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> @@ -633,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> |