philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
8718c53e6b8ca3d64b2e129a0b4401e124aef116
hdf5/doc/html/RM_H5R.html
Frank Baker 3672cb4c1c [svn-r693] Update for beta release. Complete CVS log messages can be found with 
the versions of these files that are maintained in hdf5/doc/src/.
1998-09-11 11:00:43 -05:00

249 lines
6.5 KiB
HTML
Raw Blame History

<html>
<head><title>
HDF5/H5R Draft API Specification
</title></head>
<body>
<hr>
<center>
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
H5R&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
<!--
<a href="Glossary.html">Glossary</a>
-->
</center>
<hr>
<center>
<h1>H5R: Ragged Array Interface</h1>
</center>
<h2>Ragged Array API Functions</h2>
<table border=1>
<tr><th align=left>
<font color=red>
The H5R Interface is strictly experimental at this time;
the interface may change dramatically or support for ragged arrays
may be unavailable in future in releases. As a result, future releases
may be unable to retrieve data stored with this interface.
<p><center>Use these functions at your own risk!<br>
Do not create any archives using this interface!</center>
</font>
</th></tr>
</table>
<p>
These functions enable the user to store and retrieve data in ragged arrays.
<table border=0>
<tr><td valign=top>
<ul>
<li><a href="#Ragged-Create">H5Rcreate</a>
<li><a href="#Ragged-Open">H5Ropen</a>
<li><a href="#Ragged-Close">H5Rclose</a>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
<li><a href="#Ragged-Write">H5Rwrite</a>
<li><a href="#Ragged-Read">H5Rread</a>
</ul>
</td></tr>
</table>
<p>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Ragged-Create">H5Rcreate</a>
<dt><strong>Signature:</strong>
<dd><em> </em> <code>H5Rcreate</code>(<em> </em> <code> </code>,
<em> </em> <code> </code>,
<em> </em> <code> </code>
)
<dt><strong>Purpose:</strong>
<dd>
<dt><strong>Description:</strong>
<dd><code>H5Rcreate</code>
<dt><strong>Parameters:</strong>
<dl>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
</dl>
<dt><strong>Returns:</strong>
<dd>Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Ragged-Open">H5Ropen</a>
<dt><strong>Signature:</strong>
<dd><em> </em> <code>H5Ropen</code>(<em> </em> <code> </code>,
<em> </em> <code> </code>,
<em> </em> <code> </code>
)
<dt><strong>Purpose:</strong>
<dd>
<dt><strong>Description:</strong>
<dd><code>H5Ropen</code>
<dt><strong>Parameters:</strong>
<dl>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
</dl>
<dt><strong>Returns:</strong>
<dd>Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Ragged-Close">H5Rclose</a>
<dt><strong>Signature:</strong>
<dd><em> </em> <code>H5Rclose</code>(<em> </em> <code> </code>,
<em> </em> <code> </code>,
<em> </em> <code> </code>
)
<dt><strong>Purpose:</strong>
<dd>
<dt><strong>Description:</strong>
<dd><code>H5Rclose</code>
<dt><strong>Parameters:</strong>
<dl>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
</dl>
<dt><strong>Returns:</strong>
<dd>Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Ragged-Write">H5Rwrite</a>
<dt><strong>Signature:</strong>
<dd><em> </em> <code>H5Rwrite</code>(<em> </em> <code> </code>,
<em> </em> <code> </code>,
<em> </em> <code> </code>
)
<dt><strong>Purpose:</strong>
<dd>
<dt><strong>Description:</strong>
<dd><code>H5Rwrite</code>
<p>
Datatype conversion takes place at the time of a read or write
and is automatic. See the
<a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a>
section of <cite>The Data Type Interface (H5T)</cite> in the
<cite>HDF5 User's Guide</cite> for a discussion of
data conversion, including the range of conversions currently
supported by the HDF5 libraries.
<dt><strong>Parameters:</strong>
<dl>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
</dl>
<dt><strong>Returns:</strong>
<dd>Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
</dl>
<hr>
<dl>
<dt><strong>Name:</strong> <a name="Ragged-Read">H5Rread</a>
<dt><strong>Signature:</strong>
<dd><em> </em> <code>H5Rread</code>(<em> </em> <code> </code>,
<em> </em> <code> </code>,
<em> </em> <code> </code>
)
<dt><strong>Purpose:</strong>
<dd>
<dt><strong>Description:</strong>
<dd><code>H5Rread</code>
<p>
Datatype conversion takes place at the time of a read or write
and is automatic. See the
<a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a>
section of <cite>The Data Type Interface (H5T)</cite> in the
<cite>HDF5 User's Guide</cite> for a discussion of
data conversion, including the range of conversions currently
supported by the HDF5 libraries.
<dt><strong>Parameters:</strong>
<dl>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
<dt><em> </em> <code> </code>
<dd>
</dl>
<dt><strong>Returns:</strong>
<dd>Returns SUCCEED (0) if successful;
otherwise FAIL (-1).
</dl>
<hr>
<center>
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;
H5R&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
<!--
<a href="Glossary.html">Glossary</a>
-->
</center>
<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
Last modified: 1 September 1998
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink