1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7<title>Adjust</title>
8  </head>
9  <body>
10<h1><CODE>nn::fnd::ExpHeapTemplate::Adjust</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/fnd/MemoryRange/Overview.html">MemoryRange</a> Adjust(
15     <a href="../../../nn/fnd/HeapAdjustMode.html">HeapAdjustMode</a> mode
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>mode</th>
32<td>Specifies whether to reduce the heap starting from the tail (<CODE>HEAP_ADJUST_TAIL</CODE>) or the head (<CODE>HEAP_ADJUST_HEAD</CODE>) of the heap.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the range of the memory region that has become available as a result of the reduction in heap size. If the heap could not be reduced, the size of the <CODE>MemoryRange</CODE> object returned is zero. </div>
37<h2>Description</h2>
38    <div class="section">
39<p>Frees unused areas of the expanded heap to reduce the amount of memory the expanded heap uses.</p>This function has different return values than the version of the <a href="../../../nn/fnd/ExpHeapTemplate/Adjust(0).html"><CODE>Adjust</CODE></a> function that takes no arguments. This function returns an <a href="../../../nn/fnd/MemoryRange/Overview.html"><CODE>nn::fnd::MemoryRange</CODE></a> object as its return value. This <a href="../../../nn/fnd/MemoryRange/Overview.html"><CODE>nn::fnd::MemoryRange</CODE></a> object can be used to create a new heap in the freed memory region.
40
41We do not recommend using the version of the <a href="../../../nn/fnd/ExpHeapTemplate/Adjust(0).html"><CODE>Adjust</CODE></a> function that takes no arguments. When using the <CODE>Adjust</CODE> function, use the version documented on this page.</div>
42<h2>Revision History</h2>
43    <div class="section">
44      <dl class="history">
45        <dt>2010/01/14</dt>
46<dd>Added this as an overloaded function with an argument that allows the direction of reduction to be specified.<br />
47        </dd>
48      </dl>
49    </div>
50  <hr><p>CONFIDENTIAL</p></body>
51</html>