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>Receive</title>
8  </head>
9  <body>
10<h1><CODE>nn::rdt::CTR::Receiver::Receive</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../../nn/Result/Overview.html">nn::Result</a> Receive(
15     void * pBuf,
16     size_t * pRecvSize,
17     size_t bufSize
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>out</td>
33<th>pBuf</th>
34<td>Takes the starting address of the buffer where the received data is written.</td>
35        </tr>
36        <tr>
37<td>out</td>
38<th>pRecvSize</th>
39<td>Records the number of bytes that were read from the receive buffer. If no data was readable, this is set to <CODE>0</CODE>.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>bufSize</th>
44<td>Takes the size (in bytes) of the buffer where the received data is written. If this is set to <CODE>0</CODE>, the function does nothing and returns a non-error value.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the function's result. Specifically, the following values may be returned: <CODE>ResultSuccess</CODE>, <CODE><a href="../../../../nn/rdt/CTR/ResultDoNothing/Overview.html">ResultDoNothing</a></CODE>, <CODE><a href="../../../../nn/rdt/CTR/ResultNotInitialized/Overview.html">ResultNotInitialized</a></CODE>, <CODE><a href="../../../../nn/rdt/CTR/ResultNullPointer/Overview.html">ResultNullPointer</a></CODE>, and <CODE><a href="../../../../nn/rdt/CTR/ResultUntimelyFunctionCall/Overview.html">ResultUntimelyFunctionCall</a></CODE>. </div>
49<h2>Description</h2>
50    <div class="section">
51<p>Reads the data that has accumulated in the receive buffer.</p><p>Nintendo recommends calling this approximately once per game frame to improve throughput.</p><!-- write here --></div>
52<h2>Revision History</h2>
53    <div class="section">
54      <dl class="history">
55        <dt>2010/06/14</dt>
56<dd>Initial version.<br />
57        </dd>
58      </dl>
59    </div>
60  <hr><p>CONFIDENTIAL</p></body>
61</html>