diff options
| -rw-r--r-- | doc/html/RM_H5.html | 36 |
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> </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 <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> |