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>GetSharedMemorySize</title>
8  </head>
9  <body>
10    <h1><CODE>nn::swkbd::CTR::GetSharedMemorySize</CODE> Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14s32 GetSharedMemorySize(
15     const <a href="../../../nn/swkbd/CTR/Config/Overview.html">Config</a> * pConfig,
16     const void * pInitialStatusData = NULL,
17     const void * pInitialLearningData = NULL
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>in</td>
33          <th>pConfig</th>
34          <td>The <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>Config</CODE></a> structure.</td>
35        </tr>
36        <tr>
37          <td>in</td>
38          <th>pInitialStatusData</th>
39          <td>The starting address of the initial operating status data at startup.</td>
40        </tr>
41        <tr>
42          <td>in</td>
43          <th>pInitialLearningData</th>
44          <td>The starting address of the initial predictive text learning data at startup.</td>
45        </tr> </table>
46    </div>
47    <h2>Return Values</h2>
48    <div class="section">The size of the necessary shared memory region. It is a multiple of 4096. When a shared memory region is unneeded, returns <CODE>0</CODE>. Returns a negative value on failure. </div>
49    <h2>Description</h2>
50    <div class="section">
51      <p>Calculates the size of the necessary shared memory region from the settings of the <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>Config</CODE></a> structure.</p><p>Before calling this function, you must always call the <a href="../../../nn/swkbd/CTR/InitializeConfig.html"><CODE>nn::swkbd::CTR::InitializeConfig</CODE></a> function to initialize the <a href="../../../nn/swkbd/CTR/Config/Overview.html"><CODE>nn::swkbd::CTR::Config</CODE></a> structure, and you must appropriately set the various member variables used for input.</p><p>For <span class="argument">pInitialStatusData</span>, specify the starting address of the operating status data to apply to the software keyboard's operating status when is started. <br /> If not specifying the operating status, specify <CODE>NULL</CODE>.</p><p>For <span class="argument">pInitialLearningData</span>, specify the starting address of the predictive text learning data to apply to the software keyboard's predictive text learning status when it is started. <br /> If not specifying any predictive text learning data, specify <CODE>NULL</CODE>.</p></div>
52    <h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2011/03/01</dt>
56        <dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>