summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2000-07-17 17:54:48 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2000-07-17 17:54:48 (GMT)
commit0012ab9639333361a6da263214cbcab4aa5e17be (patch)
tree450cab4ada536a3985056f9701f4768bc992e4f0
parent27a8936a270204a122cab1445ab032c71d4f878e (diff)
downloadhdf5-0012ab9639333361a6da263214cbcab4aa5e17be.zip
hdf5-0012ab9639333361a6da263214cbcab4aa5e17be.tar.gz
hdf5-0012ab9639333361a6da263214cbcab4aa5e17be.tar.bz2
[svn-r2430] RM_H5.html
Added new function H5garbage_collect.
-rw-r--r--doc/html/RM_H5.html36
1 files changed, 35 insertions, 1 deletions
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html
index 18d23b5..6e2d886 100644
--- a/doc/html/RM_H5.html
+++ b/doc/html/RM_H5.html
@@ -62,6 +62,7 @@ and it users.
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
+ <li><a href="#Library-GarbageCollect">H5garbage_collect</a>
<li><a href="#Library-DontAtExit">H5dont_atexit</a>
</ul>
</td></tr>
@@ -116,6 +117,37 @@ and it users.
<hr>
<dl>
+<dt><strong>Name:</strong> <a name="Library-GarbageCollect">H5garbage_collect</a>
+<dt><strong>Signature:</strong>
+ <dd><em>herr_t</em> <code>H5garbage_collect</code>(<em>void</em>)
+<dt><strong>Purpose:</strong>
+ <dd>Garbage collects on all free-lists of all types.
+<dt><strong>Description:</strong>
+ <dd><code>H5garbage_collect</code> walks through all the garbage
+ collection routines of the library, freeing any unused memory.
+ <p>
+ It is not required that <code>H5garbage_collect</code> be called
+ at any particular time; it is only necessary in certain situations
+ where the application has performed actions that cause the library
+ to allocate many objects. The application should call
+ <code>H5garbage_collect</code> if it eventually releases those
+ objects and wants to reduce the memory used by the library from
+ the peak usage required.
+ <p>
+ The library automatically garbage collects all the free lists
+ when the application ends.
+<dt><strong>Parameters:</strong>
+ <dl>
+ <dt>None.
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns a non-negative value if successful;
+ otherwise returns a negative value.
+</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>)
@@ -253,7 +285,9 @@ H5&nbsp;&nbsp;
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
<br>
-Last modified: 30 October 1998
+Last modified: 4 May 2000
+<br>
+Describes HDF5 Version 1.3 (Unrelased development version. Dynamic.)
</body>
</html>