diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 1998-07-15 04:37:39 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 1998-07-15 04:37:39 (GMT) |
| commit | 3e213ecf064638989c816ba3a10b3b6c6307fdad (patch) | |
| tree | 46469ba129015faaf4d275b20f8f2b033c1461d6 /doc/src/RM_H5.html | |
| parent | 3a4ad842e1fde72698b45f5d143b46076a643756 (diff) | |
| download | hdf5-3e213ecf064638989c816ba3a10b3b6c6307fdad.zip hdf5-3e213ecf064638989c816ba3a10b3b6c6307fdad.tar.gz hdf5-3e213ecf064638989c816ba3a10b3b6c6307fdad.tar.bz2 | |
[svn-r502] HDF5 Reference Manual
Final updates for Alpha2.
All currently-implemented functions added.
Technical content verified.
Diffstat (limited to 'doc/src/RM_H5.html')
| -rwxr-xr-x | doc/src/RM_H5.html | 220 |
1 files changed, 220 insertions, 0 deletions
diff --git a/doc/src/RM_H5.html b/doc/src/RM_H5.html new file mode 100755 index 0000000..8b2ab70 --- /dev/null +++ b/doc/src/RM_H5.html @@ -0,0 +1,220 @@ +<html> +<head><title> +HDF5/H5 Draft API Specification +</title></head> + +<body> + +<hr> +<center> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +H5 +<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> +<a href="RM_H5S.html">H5S</a> +<a href="RM_H5T.html">H5T</a> +<a href="RM_H5Z.html">H5Z</a> +<a href="Glossary.html">Glossary</a> +</center> +<hr> + +<center> +<h1>H5: General Library Functions</h1> +</center> + +These functions serve general-purpose needs of the HDF5 library +and it users. + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Library-Open">H5open</a> + <li><a href="#Library-Close">H5close</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Library-Version">H5version</a> + <li><a href="#Library-VersCheck">H5vers_check</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Library-DontAtExit">H5dont_atexit</a> +</ul> +</td></tr> +</table> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Library-Open">H5open</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5open</code>(<em>void</em>) +<dt><strong>Purpose:</strong> + <dd>Flushes all data to disk, closes file identifiers, and cleans up memory. +<dt><strong>Description:</strong> + <dd><code>H5open</code> initialize the library. This function is + normally called automatically, but if you find that an + HDF5 library function is failing inexplicably, try calling + this function first. +<dt><strong>Parameters:</strong> + <dl> + <dt>None. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Library-Close">H5close</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5close</code>(<em>void</em>) +<dt><strong>Purpose:</strong> + <dd>Flushes all data to disk, closes file identifiers, and cleans up memory. +<dt><strong>Description:</strong> + <dd><code>H5close</code> flushes all data to disk, + closes all file identifiers, and cleans up all memory used by + the library. This function is generall called when the + application calls <code>exit</code>, but may be called earlier + in event of an emergency shutdown or out of desire to free all + resources used by the HDF5 library. +<dt><strong>Parameters:</strong> + <dl> + <dt>None. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Library-DontAtExit">H5dont_atexit</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5dont_atexit</code>(<em>void</em>) +<dt><strong>Purpose:</strong> + <dd>Instructs library not to install <code>atexit</code> cleanup routine. +<dt><strong>Description:</strong> + <dd><code>H5dont_atexit</code> indicates to the library that an + <code>atexit()</code> cleanup routine should not be installed. + The major purpose for this is in situations where the + library is dynamically linked into an application and is + un-linked from the application before <code>exit()</code> gets + called. In those situations, a routine installed with + <code>atexit()</code> would jump to a routine which was + no longer in memory, causing errors. + <p> + In order to be effective, this routine <em>must</em> be called + before any other HDF function calls, and must be called each + time the library is loaded/linked into the application + (the first time and after it's been un-loaded). +<dt><strong>Parameters:</strong> + <dl> + <dt>None. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Library-Version">H5version</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5version</code>(<em>unsigned *</em><code>majnum</code>, + <em>unsigned *</em><code>minnum</code>, + <em>unsigned *</em><code>relnum</code>, + <em>unsigned *</em><code>patnum</code> + ) +<dt><strong>Purpose:</strong> + <dd> +<dt><strong>Description:</strong> + <dd><code>H5version</code> retrieves the major, minor, release, and + patch versions of the library which is linked to the application. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>unsigned *</em><code>majnum</code> + <dd>The major version of the library. + <dt><em>unsigned *</em><code>minnum</code> + <dd>The minor version of the library. + <dt><em>unsigned *</em><code>relnum</code> + <dd>The release number of the library. + <dt><em>unsigned *</em><code>patnum</code> + <dd>The patch number of the library. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Library-VersCheck">H5vers_check</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5vers_check</code>(<em>unsigned *</em><code>majnum</code>, + <em>unsigned *</em><code>minnum</code>, + <em>unsigned *</em><code>relnum</code>, + <em>unsigned *</em><code>patnum</code> + ) +<dt><strong>Purpose:</strong> + <dd> +<dt><strong>Description:</strong> + <dd><code>H5vers_check</code> verifies that the arguments match the + version numbers compiled into the library. This function is intended + to be called from user to verify that the versions of header files + compiled into the application match the version of the HDF5 library. + <p> + Due to the risks of data corruption or segmentation faults, + <code>H5vers_check</code> causes the application to abort if the + version numbers do not match. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>unsigned *</em><code>majnum</code> + <dd>The major version of the library. + <dt><em>unsigned *</em><code>minnum</code> + <dd>The minor version of the library. + <dt><em>unsigned *</em><code>relnum</code> + <dd>The release number of the library. + <dt><em>unsigned *</em><code>patnum</code> + <dd>The patch number of the library. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful. + Upon failure, this function causes the application to abort. +</dl> + + +<hr> +<center> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +H5 +<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> +<a href="RM_H5S.html">H5S</a> +<a href="RM_H5T.html">H5T</a> +<a href="RM_H5Z.html">H5Z</a> +<a href="Glossary.html">Glossary</a> +</center> +<hr> + +<address> +<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> + +<br> +Last modified: 14 July 1998 + +</body> +</html> |