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>GetNextReceiveDataSize</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/ir/Overview.html">ir</a>::<a href="../../../../nn/ir/CTR/Overview.html">CTR</a>::<a href="../../../../nn/ir/CTR/Communicator/Overview.html">Communicator</a>::GetNextReceiveDataSize</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nn/Result/Overview.html">Result</a> GetNextReceiveDataSize(
15     size_t * pSize
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>out</td>
31          <th>pSize</th>
32          <td>Stores the size of the receive data.</td>
33        </tr> </table>
34    </div>
35    <h2>Return Values</h2>
36    <div class="section">Returns the function's execution result. Returns one of the <a href="../../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below.<br /> <br />
37      <table class="arguments">
38        <thead>
39          <tr>
40            <th>Value</th>
41            <td>Description</td>
42          </tr>
43        </thead>
44        <tr>
45          <th><CODE>Result::IsSuccess</CODE></th>
46          <td>Process was successful.</td>
47        </tr>
48        <tr>
49          <th><CODE>ResultNotConnected</CODE></th>
50          <td>System is not connected.</td>
51        </tr>
52        <tr>
53          <th><CODE>ResultNoData</CODE></th>
54          <td>No received data.</td>
55        </tr>
56        <tr>
57          <th><CODE>ResultMachineSleep</CODE></th>
58          <td>Sleeping because the system is in Sleep Mode.</td>
59        </tr>
60        <tr>
61          <th><CODE>ResultFatalError</CODE></th>
62          <td>The IR module may be malfunctioning.</td>
63        </tr>
64      </table> </div>
65    <h2>Description</h2>
66    <div class="section">
67      <p>Returns the size of data that will be received in the next call to the <CODE>Receive</CODE> function.</p><p>This size includes the header and other data added for communication between systems. In other words, it returns the size of the portion of the received packet that is calculated by the <CODE>CalculateBufferSizeToCommunicate</CODE> function.</p><p>Use this function when you need to know ahead of time the buffer size required to execute the <CODE>Receive</CODE> function.</p><!-- write here --></div>
68    <h2>Revision History</h2>
69    <div class="section">
70      <dl class="history">
71        <dt>2011/08/30</dt>
72        <dd>Initial version.<br />
73        </dd>
74      </dl>
75    </div>
76  <hr><p>CONFIDENTIAL</p></body>
77</html>
78