diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1998-09-10 15:40:15 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1998-09-10 15:40:15 (GMT) |
commit | 750856c53aa1cae3217e853ab7571b20bc658ffc (patch) | |
tree | 2ad244b7c01b98180e29883c74c87d4262ac1c62 /doc/src/RM_H5G.html | |
parent | d07894304f4a608af828aee0a99dbb875fba1fa1 (diff) | |
download | hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.zip hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.tar.gz hdf5-750856c53aa1cae3217e853ab7571b20bc658ffc.tar.bz2 |
[svn-r684] RM_H5Front.html
Added link to Tools.html
Clean up formatting.
Added RM_H5R.html, Ragged Arrays, but link is commented out for Beta.
RM_H5.html
H5version Removed patch number parameter.
H5check_version Removed patch number parameter.
Corrected datatype to unsigned (was unsigned *).
Added missing "Purpose:" statement.
RM_H5A.html
H5Aread/write Added reference to data conversion limitations.
RM_H5D.html
H5Dwrite Added "Writing to an external dataset will fail
if the HDF5 file is not open for writing."
H5Dread/write Added reference to data conversion limitations.
RM_H5F.html
H5Fflush Added H5Fflush.
RM_H5G.html
H5Gget_stat Fixed formatting error.
Added mtime to the description of the data structure.
Added the following "Note:", per Robb's checkin mesage:
"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 mtime
value of 0 (zero)."
Corrected successful return value.
H5Gset_comment Added the following statement to "Description:"
"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.
RM_H5P.html
Cleaned up file formatting.
H5Pset_filter Added these three functions.
H5Pget_nfilters
H5Pget_filter
H5Pget_deflate Removed these three functions. (Actually,
H5Pset_compression they are commented out, in case they should
H5Pget_compression be reinstated.)
RM_H5R.html
Intial version of H5R reference manual entry, but still largely
just a template.
Not yet ready for distribution.
Links to this document are currently commented out.
RM_H5S.html
H5S_set_extent_simple Changed name to H5Sselect_extent_simple.
now: H5Sselect_extent_simpl
H5Sselect_npoints Corrected return value.
Now: H5Sget_select_npoints
H5Sget_class Reinstated to RM. Changed name.
now: H5Sget_space_type
H5Soffset_simple Added these 6 functions. The there is a
H5Sextent_copy link to Dataspaces.html for the 10 "not yet
H5Sset_extent_none implemented (NYI)" functions.
H5Sselect_all
H5Sselect_none
H5Sselect_valid
RM_H5T.html
Added the following datatypes (though the list of native datatypes
is commented out):
H5T_NATIVE_HSIZE
H5T_NATIVE_HSSIZE
H5T_NATIVE_HERR
H5T_NATIVE_HBOOL
Tools.html
Corrected h5ls and h5repart sections.
Glossary.html
Unlinked for Beta.
Copyright.html
New file.
Copyright statement, linked into User's Guide and Reference Manual.
General
Changed the following function names:
From: To:
H5version H5get_libversion
H5vers_check H5check_version
H5Anum_attrs H5Aget_num_attrs
H5Fget_create_template H5Fget_create_plist
H5Fget_access_template H5Fget_access_plist
And associated "template" -> "property list" edits.
H5Gstat H5Gget_stat
H5Sextent_npoints H5Sget_simple_extent_npoints
H5Sextent_ndims H5Sget_simple_extent_ndims
H5Sextent_dims H5Sget_simple_extent_dims
H5Sget_class H5Sget_simple_extent_type
H5Sselect_npoints H5Sget_select_npoints
Added links to Tools.html and RM_H5R.html (Ragged Arrays),
though link to RM_H5R.html is commented out for now.
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> |