diff options
Diffstat (limited to 'doc/src/RM_H5R.html')
| -rw-r--r-- | doc/src/RM_H5R.html | 248 |
1 files changed, 0 insertions, 248 deletions
diff --git a/doc/src/RM_H5R.html b/doc/src/RM_H5R.html deleted file mode 100644 index 4e1fd7c..0000000 --- a/doc/src/RM_H5R.html +++ /dev/null @@ -1,248 +0,0 @@ -<html> -<head><title> -HDF5/H5R Draft API Specification -</title></head> - -<body> - -<hr> -<center> -<a href="RM_H5Front.html">HDF5 Reference Manual</a> -<a href="RM_H5.html">H5</a> -<a href="RM_H5A.html">H5A</a> -<a href="RM_H5D.html">H5D</a> -<a href="RM_H5E.html">H5E</a> -<a href="RM_H5F.html">H5F</a> -<a href="RM_H5G.html">H5G</a> -<a href="RM_H5P.html">H5P</a> -H5R -<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> - -<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> </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> -<a href="RM_H5.html">H5</a> -<a href="RM_H5A.html">H5A</a> -<a href="RM_H5D.html">H5D</a> -<a href="RM_H5E.html">H5E</a> -<a href="RM_H5F.html">H5F</a> -<a href="RM_H5G.html">H5G</a> -<a href="RM_H5P.html">H5P</a> -H5R -<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> - -<address> -<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> - -<br> -Last modified: 1 September 1998 - -</body> -</html> |