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>SetString</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../nw/Overview.html">nw</a>::<a href="../../../nw/lyt/Overview.html">lyt</a>::<a href="../../../nw/lyt/TextBox/Overview.html">TextBox</a>::SetString</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14virtual <span>u16</span> SetString(
15     const wchar_t*                  str,
16     <span>u16</span> dstIdx,
17     <span>u16</span> strLen
18);
19</pre>
20    </div>
21    <h2>Arguments</h2>
22    <div class="section">
23      <table class="arguments">
24        <thead>
25          <tr>
26            <td width="15" />
27            <th>Name</th>
28            <td>Description</td>
29          </tr>
30        </thead>
31        <tr>
32          <td />
33          <th>str</th>
34          <td>The text string to be stored.</td>
35        </tr>
36        <tr>
37          <td />
38          <th>dstIdx</th>
39          <td>The storage location.</td>
40        </tr>
41        <tr>
42          <td />
43          <th>strLen</th>
44          <td>Length of the text string to be stored</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">Returns the length of the stored text string. </div>
49    <h2>Description</h2>
50    <div class="section">
51      <p>Stores a text string in the text buffer.</p><p>The length of the text string is specified by <SPAN class="argument">strLen</SPAN>. The NULL terminator is not detected.</p><p>Should the length of the specified string exceed that of the text buffer, the portion that exceeds the length of the text buffer will be cut off.</p></div>
52    <h2>See Also</h2>
53    <div class="section">
54      <p class="reference"><a href="../../../nw/lyt/TextBox/GetString.html">GetString</a><br /><a href="../../../nw/lyt/TextBox/GetStringLength.html">GetStringLength</a><br /> </p>
55    </div>
56    <h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2010/04/09</dt>
60        <dd>There was a mistake in the description regarding when the value of <SPAN class="argument">strLen</SPAN> is 0. A value of 0 does not include the null terminator.<BR>
61        </dd>
62        <dt>2009/09/18</dt>
63        <dd>Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>
69