summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2003-04-17 21:02:41 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2003-04-17 21:02:41 (GMT)
commite68390cdc50170a5a9aeb30c9c6952d18e1bd11e (patch)
tree938ec1f8d654ab04ad5a4a4a3e8a97b9adfa4184 /doc
parent242f50e03e1423ea7be9a8ebb531aa018f7eac18 (diff)
downloadhdf5-e68390cdc50170a5a9aeb30c9c6952d18e1bd11e.zip
hdf5-e68390cdc50170a5a9aeb30c9c6952d18e1bd11e.tar.gz
hdf5-e68390cdc50170a5a9aeb30c9c6952d18e1bd11e.tar.bz2
[svn-r6704]
Purpose: Add new function. Description: Added H5set_free_list_limits. Platforms tested: Safari, IE 5
Diffstat (limited to 'doc')
-rw-r--r--doc/html/RM_H5.html69
1 files changed, 68 insertions, 1 deletions
diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html
index a094ad8..293c7ab 100644
--- a/doc/html/RM_H5.html
+++ b/doc/html/RM_H5.html
@@ -65,6 +65,7 @@ and it users.
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
+ <li><a href="#Library-SetFreeListLimits">H5set_free_list_limits</a>
<li><a href="#Library-GarbageCollect">H5garbage_collect</a>
<li><a href="#Library-DontAtExit">H5dont_atexit</a>
</ul>
@@ -99,6 +100,7 @@ facilitate moving easily between them.</i>
</ul>
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
<ul>
+<!--<li><a href="#Library-SetFreeListLimits">h5set_free_list_limits_f</a>-->
<li><a href="#Library-GarbageCollect">h5garbage_collect_f</a>
<li><a href="#Library-DontAtExit">h5dont_atexit_f</a>
</ul>
@@ -168,6 +170,71 @@ facilitate moving easily between them.</i>
<hr>
<dl>
+<dt><strong>Name:</strong> <a name="Library-SetFreeListLimits">H5set_free_list_limits</a>
+<dt><strong>Signature:</strong>
+ <dd><em>herr_t</em> <code>H5set_free_list_limits</code>(<em>int</em> <code>reg_global_lim</code>,
+ <em>int</em> <code>reg_list_lim</code>,
+ <em>int</em> <code>arr_global_lim</code>,
+ <em>int</em> <code>arr_list_lim</code>,
+ <em>int</em> <code>blk_global_lim</code>,
+ <em>int</em> <code>blk_list_lim</code>
+ )
+<dt><strong>Purpose:</strong>
+ <dd>Sets free-list size limits.
+<dt><strong>Description:</strong>
+ <dd><code>H5set_free_list_limits</code> sets size limits
+ on all types of free lists.
+ Free lists are
+ <b><font color="red "size="+1">
+ ... just what, exactly?
+ </font></b>
+ <p>
+ These are global limits, but each limit applies only to
+ free lists of the specified type.
+ Therefore, if an application sets a 1Mb limit on each of
+ the global lists, up to 3Mb of total storage might be
+ allocated, 1Mb for each of the regular, array, and
+ block type lists.
+ <p>
+ Using a value of <code?>-1</code> for a limit means that
+ no limit is set for the specified type of free list.
+<dt><strong>Parameters:</strong>
+ <dl>
+
+ <dt><b><font color="red "size="+1">
+ Why is <i>regular</i> quoted below?
+ What would be, say, <i>irregular</i>?
+ </font></b>
+
+ <dt><em>int</em> <code>reg_global_lim</code>
+ <dd>IN: The limit on all "regular" free list memory used
+ <dt><em>int</em> <code>reg_list_lim</code>
+ <dd>IN: The limit on memory used in each "regular" free list
+ <dt><em>int</em> <code>arr_global_lim</code>
+ <dd>IN: The limit on all "array" free list memory used
+ <dt><em>int</em> <code>arr_list_lim</code>
+ <dd>IN: The limit on memory used in each "array" free list
+ <dt><em>int</em> <code>blk_global_lim</code>
+ <dd>IN: The limit on all "block" free list memory used
+ <dt><em>int</em> <code>blk_list_lim</code>
+ <dd>IN: The limit on memory used in each "block" free list
+ </dl>
+<dt><strong>Returns:</strong>
+ <dd>Returns a non-negative value if successful;
+ otherwise returns a negative value.
+<!--
+<dt><strong>Non-C API(s):</strong>
+ <dd><a href="fortran/h5_FORTRAN.html#h5set_free_list_limits_f"
+ target="FortranWin"><img src="Graphics/FORTRAN.gif" border=0></a>
+--> <!--
+ <img src="Graphics/Java.gif">
+ <img src="Graphics/C++.gif">
+ -->
+</dl>
+
+
+<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>)
@@ -415,7 +482,7 @@ And in this document, the
Describes HDF5 Release 1.5, Unreleased Development Branch
</address><!-- #EndLibraryItem -->
-Last modified: 3 April 2003
+Last modified: 11 April 2003
</body>
</html>