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>SetBuffer</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/font/Overview.html">font</a>::<a href="../../../nw/font/TextWriterBase/Overview.html">TextWriterBase</a>::SetBuffer</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static void * SetBuffer(
15     CharType*   buffer,
16     std::size_t size
17);
18</pre>
19    </div>
20    <h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26            <th>Name</th>
27            <td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31          <td>in</td>
32          <th>buffer</th>
33          <td>Pointer to the buffer allocated for <CODE>TextWriter</CODE>.</td>
34        </tr>
35        <tr>
36          <td>in</td>
37          <th><CODE>size</CODE></th>
38          <td>Buffer size</td>
39        </tr> </table>
40    </div>
41    <h2>Return Values</h2>
42    <div class="section">If a buffer was previously allocated <CODE>TextWriter</CODE>, the pointer to that buffer is returned.  Returns NULL if the allocated buffer does not exist. </div>
43    <h2>Description</h2>
44    <div class="section">
45      <p>Allocates a buffer for extracting formatted text.</p><p>This buffer is used to extract a formatted character string using a member function of TextWriter for handling formatted character strings. If the character string after extraction exceeds the size of this buffer, the excessive part of the string is truncated for the process. <br /> The five functions listed below are <CODE><a href="../../../nw/font/TextWriter.html">nw::font::TextWriter</a></CODE> member functions that handle formatted character strings.<br /><br /> <CODE>nw::font::TextWriter::CalcFormatStringWidth</CODE><br /> <CODE>nw::font::TextWriter::CalcFormatStringHeight </CODE> <br /><CODE>nw::font::TextWriter::CalcFormatStringRect</CODE> <br /> <CODE>nw::font::TextWriter::Printf</CODE><br /> <CODE>nw::font::TextWriter::VPrintf</CODE> .
46</p><p>For the format that specifies only the buffer size, the buffer is specified such that it is allocated on the stack. <B>Note:</B> The stack may overflow if an attempt is made to allocate too large a buffer on the stack.</p><p>A buffer holding 256 characters is allocated on the stack by default.</p></div>
47    <h2>Revision History</h2>
48    <div class="section">
49      <dl class="history">
50        <dt>2009/11/09</dt>
51        <dd>Initial version.<br />
52        </dd>
53      </dl>
54    </div>
55  <hr><p>CONFIDENTIAL</p></body>
56</html>
57