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>LockSheet</title>
8  </head>
9  <body>
10    <h1><CODE>nw::font::PackedFont::LockSheet</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool LockSheet(
15     <a href="../../../nw/font/CharCode.html">CharCode</a> c
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>c</th>
32          <td>Character code indicating the glyph included on the sheet to be locked.</td>
33        </tr> </table>
34    </div>
35    <h2>Return Values</h2>
36    <div class="section">Returns <br />true</code> if locked or <br />false</code> if the locking could not be performed.<br /> Locking cannot be performed once the maximum number of lockable sheets has been exceeded. </div>
37    <h2>Description</h2>
38    <div class="section">
39      <p>Prevents sheets in cache from being discarded.</p><p>With the <CODE>PackedFont</CODE> class, sheets are maintained in a compressed state and expanded and cached as needed by functions such as the <CODE><a href="../../../nw/font/PackedFont/GetGlyph.html">nw::font::PackedFont::GetGlyph</a></CODE> function.  When there is insufficient cache available, the cache last used is discarded to free up cache. <br /> By using this function, a sheet can be excluded from the discard targets even when cache becomes insufficient. Performance may be improved by locking sheets that contain characters that are used frequently, such as ASCII characters or Japanese hiragana.</p><p>The maximum number of sheets that can be locked is (number of caches - 1).</p></div>
40    <h2>See Also</h2>
41    <div class="section">
42      <p class="reference"><a href="../../../nw/font/PackedFont/GetNumCache.html">nw::font::PackedFont::GetNumCache</a><br /><a href="../../../nw/font/PackedFont/UnlockSheet.html">nw::font::PackedFont::UnlockSheet</a><br /><a href="../../../nw/font/PackedFont/UnlockSheetAll.html">nw::font::PackedFont::UnlockSheetAll</a><br /> </p>
43    </div>
44    <h2>Revision History</h2>
45    <div class="section">
46      <dl class="history">
47        <dt>2009/11/09</dt>
48        <dd>Initial version.<br />
49        </dd>
50      </dl>
51    </div>
52  <hr><p>CONFIDENTIAL</p></body>
53</html>