diff options
author | Frank Baker <fbaker@hdfgroup.org> | 2000-06-02 22:20:23 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 2000-06-02 22:20:23 (GMT) |
commit | 4d1ff63f4a4e1acf2f434acb66889aaeb3135194 (patch) | |
tree | cc3530f5a5bab04a6a5550bf8e148a63e347eb37 | |
parent | 6dae18b99309c6d78b33088d4d5129868e4ab3ab (diff) | |
download | hdf5-4d1ff63f4a4e1acf2f434acb66889aaeb3135194.zip hdf5-4d1ff63f4a4e1acf2f434acb66889aaeb3135194.tar.gz hdf5-4d1ff63f4a4e1acf2f434acb66889aaeb3135194.tar.bz2 |
[svn-r2335] RM_H5.html: Added H5garbage_collect.
-rw-r--r-- | doc/html/RM_H5.html | 40 |
1 files changed, 36 insertions, 4 deletions
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 18d23b5..d48fb60 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -10,9 +10,9 @@ HDF5/H5 API Specification <center> <table border=0 width=98%> <tr><td valign=top align=left> +<a href="index.html">HDF5 documents and links</a> <br> <a href="H5.intro.html">Introduction to HDF5</a> <br> -<a href="H5.user.html">HDF5 User Guide</a> <br> -<a href="index.html">Other HDF5 documents and links</a> <br> +<a href="H5.user.html">HDF5 User's Guide</a> <br> <!-- <a href="Glossary.html">Glossary</a><br> --> @@ -62,6 +62,7 @@ and it users. </ul> </td><td> </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>) @@ -217,9 +249,9 @@ and it users. <center> <table border=0 width=98%> <tr><td valign=top align=left> +<a href="index.html">HDF5 documents and links</a> <br> <a href="H5.intro.html">Introduction to HDF5</a> <br> -<a href="H5.user.html">HDF5 User Guide</a> <br> -<a href="index.html">Other HDF5 documents and links</a> <br> +<a href="H5.user.html">HDF5 User's Guide</a> <br> <!-- <a href="Glossary.html">Glossary</a><br> --> |