summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2003-06-25 19:49:04 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2003-06-25 19:49:04 (GMT)
commit2d2c6e8a18dcb19ea08e519ef4537161de277e83 (patch)
tree58901114e80dfce50cd15bccb422eec3fd714af5
parentfa77b6691e218c49163f477c84fb8664fb5cda8b (diff)
downloadhdf5-2d2c6e8a18dcb19ea08e519ef4537161de277e83.zip
hdf5-2d2c6e8a18dcb19ea08e519ef4537161de277e83.tar.gz
hdf5-2d2c6e8a18dcb19ea08e519ef4537161de277e83.tar.bz2
[svn-r7105]
Purpose: New function. "HDF5 Release 1.4 compatibility" note. Description: H5Rget_obj_type Added new function; replaces H5Rget_object_type. H5Rget_object_type Add "Provided for HDF5 Release 1.4 compatibility" note. Platforms tested: IE 5, Safari
-rw-r--r--doc/html/RM_H5R.html96
1 files changed, 91 insertions, 5 deletions
diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html
index 4eb2e22..8f72d8f 100644
--- a/doc/html/RM_H5R.html
+++ b/doc/html/RM_H5R.html
@@ -63,14 +63,19 @@ to specific objects and data regions in an HDF5 file.
</td><td valign=top width=40%>
<ul>
<li><a href="#Reference-GetRegion">H5Rget_region</a>
- <li><a href="#Reference-GetObjectType">H5Rget_object_type</a>
+ <li><a href="#Reference-GetObjType">H5Rget_obj_type</a>
+ <li><span class="1_4_compat"><a href="#Reference-GetObjectType">H5Rget_object_type</a></span> *
</ul>
</td><td valign=top width=20%>
<ul>
-
+ &nbsp;
</ul>
</td></tr>
</table>
+
+* Functions labelled with an asterisk (*) are provided only for
+backwards compatibility with HDF5 Releases 1.4.<i>x</i>.
+See further notes in the description of each function.
<br>
<i>Alphabetical Listing</i>
@@ -85,7 +90,7 @@ to specific objects and data regions in an HDF5 file.
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td valign="top">
- <li>H5Rget_obj_type</li>
+ <li><a href="#Reference-GetObjType">H5Rget_obj_type</a>
<li><a href="#Reference-GetObjectType">H5Rget_object_type</a>
</td>
@@ -290,6 +295,77 @@ facilitate moving easily between them.</i>
<hr>
<dl>
+<dt><strong>Name:</strong> <a name="Reference-GetObjType">H5Rget_obj_type</a>
+<dt><strong>Signature:</strong>
+ <dd><em>H5G_obj_t</em> <code>H5Rget_obj_type</code>(<em>hid_t</em> <code>id</code>,
+ <em>H5R_type_t</em> <code>ref_type</code>,
+ <em>void *</em><code>ref</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Retrieves the type of object that an object reference points to.
+<dt><strong>Description:</strong>
+ <dd>Given type of object reference, <code>ref_type</code>,
+ and a reference to an object, <code>ref</code>,
+ <code>H5Rget_obj_type</code>
+ returns the type of the referenced object.
+ <p>
+ Valid object reference types, to pass in as <code>ref</code>, include the following:
+ <table border="0">
+ <tr align=left valign=top><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>
+ <code>H5R_OBJECT</code></td><td>
+ Reference is an object reference.
+ </td></tr>
+ <tr align=left valign=top><td>&nbsp;</td><td>
+ <code>H5R_DATASET_REGION&nbsp;&nbsp;</code></td><td>
+ Reference is a dataset region reference.
+ </td></tr>
+ </table>
+ <p>
+ Valid object type return values include the following:
+ <table border="0">
+ <tr align=left valign=top><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>
+ <code>H5G_LINK</code></td><td>
+ Object is a symbolic link.
+ </td></tr>
+ <tr align=left valign=top><td>&nbsp;</td><td>
+ <code>H5G_GROUP</code></td><td>
+ Object is a group.
+ </td></tr>
+ <tr align=left valign=top><td>&nbsp;</td><td>
+ <code>H5G_DATASET&nbsp;&nbsp;</code></td><td>
+ Object is a dataset.
+ </td></tr>
+ <tr align=left valign=top><td>&nbsp;</td><td>
+ <code>H5G_TYPE</code></td><td>
+ Object is a named datatype.
+ </td></tr>
+ </table>
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>id</code>,
+ <dd>IN: The dataset containing the reference object or
+ the location identifier of the object that the
+ dataset is located within.
+ <dt><em>H5R_type_t</em> <code>ref_type</code>
+ <dd>IN: Type of reference to query.
+ <dt><em>void *</em><code>ref</code>
+ <dd>IN: Reference to query.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns an object type as defined in <code>H5Gpublic.h</code> if successful;
+ otherwise returns <code>H5G_UNKNOWN</code>.
+<dt><strong>Non-C API(s):</strong>
+ <dd><a href="fortran/h5r_FORTRAN.html#h5rget_object_type_f"
+ target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
+ <!--
+ <img src="Graphics/Java.gif">
+ <img src="Graphics/C++.gif">
+ -->
+</dl>
+
+
+<hr>
+<dl>
<dt><strong>Name:</strong> <a name="Reference-GetObjectType">H5Rget_object_type</a>
<dt><strong>Signature:</strong>
<dd><em>int</em> <code>H5Rget_object_type</code>(<em>hid_t</em> <code>id</code>,
@@ -298,7 +374,17 @@ facilitate moving easily between them.</i>
<dt><strong>Purpose:</strong>
<dd>Retrieves the type of object that an object reference points to.
<dt><strong>Description:</strong>
- <dd>Given a reference to an object <code>ref</code>,
+ <dd>[<strong>NOTE:</strong>
+ This function is provided only to enable backward compatibility
+ with HDF5 Releases 1.4.<i>x</i>.
+ This function is enabled only if the HDF5 library is compiled
+ with the flag <code>H5_WANT_H5_V1_4_COMPAT</code> and is not
+ enabled in the binaries distributed by NCSA.
+ This function has been replaced in Release 1.6 by the function
+ <a href="#Reference-GetObyType"><code>H5Rget_object_type</code></a>
+ and will eventually be deleted from the HDF5 distribution.]
+ <p>
+ </p>Given a reference to an object <code>ref</code>,
<code>H5Rget_object_type</code> returns the
type of the object pointed to.
<dt><strong>Parameters:</strong>
@@ -363,7 +449,7 @@ And in this document, the
Describes HDF5 Release 1.5, Unreleased Development Branch
</address><!-- #EndLibraryItem -->
-Last modified: 6 June 2003
+Last modified: 25 June 2003
</body>
</html>