summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2003-10-08 21:26:05 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2003-10-08 21:26:05 (GMT)
commitcccd86aa0edc1698478178ae90476281ac1caf5d (patch)
tree05fe09792b7fc7e995ecb01607c06ce4246b29b2 /doc
parentc84d9f5eabed93c22e6c898434a0246cb93e4ee8 (diff)
downloadhdf5-cccd86aa0edc1698478178ae90476281ac1caf5d.zip
hdf5-cccd86aa0edc1698478178ae90476281ac1caf5d.tar.gz
hdf5-cccd86aa0edc1698478178ae90476281ac1caf5d.tar.bz2
[svn-r7576]
Purpose: Alphabetic sort of RM function entries Additional and modified HTML coding to accomodate HTMLdoc and automated PDF generation Corrected link to the F90 subroutine h5rget_object_type_f from the H5Rget_obj_type function description Platforms tested: IE 5, Safari
Diffstat (limited to 'doc')
-rw-r--r--doc/html/RM_H5R.html133
1 files changed, 72 insertions, 61 deletions
diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html
index 5c2c4bd..f838e75 100644
--- a/doc/html/RM_H5R.html
+++ b/doc/html/RM_H5R.html
@@ -25,6 +25,7 @@ HDF5/H5R API Specification
<!-- #EndLibraryItem --></head>
<body bgcolor="#FFFFFF">
+<!-- HEADER RIGHT " " -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
@@ -60,8 +61,7 @@ And in this document, the
</td></tr>
</table>
</center>
-<hr>
-<!-- #EndLibraryItem --><center>
+<hr><!-- #EndLibraryItem --><center>
<h1>H5R: Reference Interface</h1>
</center>
@@ -91,9 +91,6 @@ to specific objects and data regions in an HDF5 file.
</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.
<p>
<i>Alphabetical Listing</i>
@@ -101,38 +98,44 @@ See further notes in the description of each function.
<table border="0">
<tr>
<td valign="top">
+ <ul>
<li><a href="#Reference-Create">H5Rcreate</a>
- <li><a href="#Reference-Dereference">H5Rdereference</a>
+ <li><a href="#Reference-Dereference">H5Rdereference</a>
+ </ul>
</td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td valign="top">
+ <ul>
<li><a href="#Reference-GetObjType">H5Rget_obj_type</a>
+ </ul>
</td>
<td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td>
<td valign="top">
+ <ul>
<li><a href="#Reference-GetRegion">H5Rget_region</a>
+ </ul>
</td>
</tr>
</table>
-<p>
+<br>
<strong>The FORTRAN90 Interfaces:</strong>
<br>
<font size=-1>
<i>In general, each FORTRAN90 subroutine performs exactly the same task
-as the corresponding C function. The links below go to the C function
+as the corresponding C function. The links below (electronic versions only) go to the C function
descriptions, which serve as general descriptions for both. A button,
under <strong>Non-C API(s)</strong> at the end of the C function description,
opens an external browser window displaying the FORTRAN90-specific
information. You will probably want to adjust the size and location of
this external window so that both browser windows are visible and to
facilitate moving easily between them.</i>
-</font>
+</font><br>
<table border=0 width=80%>
<tr><td valign=top width=40%>
@@ -143,6 +146,7 @@ facilitate moving easily between them.</i>
</td><td valign=top width=40%>
<ul>
<li><a href="#Reference-GetRegion">h5rget_region_f</a>
+ <li><a href="#Reference-GetObjType">h5rget_object_type_f</a>
</ul>
</td><td valign=top width=20%>
<ul>
@@ -154,6 +158,9 @@ facilitate moving easily between them.</i>
<p>
+<!-- NEW PAGE -->
+<!-- NEW PAGE -->
+<!-- HEADER RIGHT "H5Rcreate" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Reference-Create">H5Rcreate</a>
@@ -221,7 +228,8 @@ facilitate moving easily between them.</i>
-->
</dl>
-
+<!-- NEW PAGE -->
+<!-- HEADER RIGHT "H5Rdereference" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Reference-Dereference">H5Rdereference</a>
@@ -264,51 +272,8 @@ facilitate moving easily between them.</i>
-->
</dl>
-
-<hr>
-<dl>
-<dt><strong>Name:</strong> <a name="Reference-GetRegion">H5Rget_region</a>
-<dt><strong>Signature:</strong>
- <dd><em>hid_t</em> <code>H5Rget_region</code>(<em>hid_t</em> <code>dataset</code>,
- <em>H5R_type_t</em> <code>ref_type</code>,
- <em>void *</em><code>ref</code>
- )
-<dt><strong>Purpose:</strong>
- <dd>Retrieves a dataspace with the specified region selected.
-<dt><strong>Description:</strong>
- <dd>Given a reference to an object <code>ref</code>,
- <code>H5Rget_region</code> creates a copy of the dataspace
- of the dataset pointed to and defines a selection in the copy
- which is the region pointed to.
- <p>
- The parameter <code>ref_type</code> specifies the reference type
- of <code>ref</code>.
- <code>ref_type</code> may contain the following value:
- <ul>
- <li><code>H5R_DATASET_REGION</code> (<code>1</code>)
- </ul>
-<dt><strong>Parameters:</strong>
- <dl>
- <dt><em>hid_t</em> <code>dataset</code>,
- <dd>IN: Dataset containing reference object.
- <dt><em>H5R_type_t</em> <code>ref_type</code>,
- <dd>IN: The reference type of <code>ref</code>.
- <dt><em>void *</em><code>ref</code>
- <dd>IN: Reference to open.
- </dl>
-<dt><strong>Returns:</strong>
- <dd>Returns a valid identifier if successful;
- otherwise returns a negative value.
-<dt><strong>Non-C API(s):</strong>
- <dd><a href="fortran/h5r_FORTRAN.html#h5rget_region_f"
- target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
- <!--
- <img src="Graphics/Java.gif">
- <img src="Graphics/C++.gif">
- -->
-</dl>
-
-
+<!-- NEW PAGE -->
+<!-- HEADER RIGHT "H5Rget_obj_type" -->
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Reference-GetObjType">H5Rget_obj_type</a>
@@ -372,7 +337,7 @@ facilitate moving easily between them.</i>
<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_obj_type_f"
+ <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">
@@ -381,6 +346,51 @@ facilitate moving easily between them.</i>
</dl>
+<!-- NEW PAGE -->
+<!-- HEADER RIGHT "H5Rget_region" -->
+<hr>
+<dl>
+<dt><strong>Name:</strong> <a name="Reference-GetRegion">H5Rget_region</a>
+<dt><strong>Signature:</strong>
+ <dd><em>hid_t</em> <code>H5Rget_region</code>(<em>hid_t</em> <code>dataset</code>,
+ <em>H5R_type_t</em> <code>ref_type</code>,
+ <em>void *</em><code>ref</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Retrieves a dataspace with the specified region selected.
+<dt><strong>Description:</strong>
+ <dd>Given a reference to an object <code>ref</code>,
+ <code>H5Rget_region</code> creates a copy of the dataspace
+ of the dataset pointed to and defines a selection in the copy
+ which is the region pointed to.
+ <p>
+ The parameter <code>ref_type</code> specifies the reference type
+ of <code>ref</code>.
+ <code>ref_type</code> may contain the following value:
+ <ul>
+ <li><code>H5R_DATASET_REGION</code> (<code>1</code>)
+ </ul>
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt><em>hid_t</em> <code>dataset</code>,
+ <dd>IN: Dataset containing reference object.
+ <dt><em>H5R_type_t</em> <code>ref_type</code>,
+ <dd>IN: The reference type of <code>ref</code>.
+ <dt><em>void *</em><code>ref</code>
+ <dd>IN: Reference to open.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns a valid identifier if successful;
+ otherwise returns a negative value.
+<dt><strong>Non-C API(s):</strong>
+ <dd><a href="fortran/h5r_FORTRAN.html#h5rget_region_f"
+ target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
+ <!--
+ <img src="Graphics/Java.gif">
+ <img src="Graphics/C++.gif">
+ -->
+</dl>
+
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" --><hr>
<center>
<table border=0 width=98%>
@@ -414,14 +424,15 @@ And in this document, the
</td></tr>
</table>
</center>
-<hr>
-<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
+<hr><!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" --><address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Describes HDF5 Release 1.6.0, July 2003
-</address><!-- #EndLibraryItem -->
-
-Last modified: 25 June 2003
+</address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
+<!--
+document.writeln("Last modified: 8 October 2003");
+-->
+</SCRIPT>
</body>
</html>