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::uds::CTR::Receive</CODE> 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     const <a href="../../../nn/uds/CTR/EndpointDescriptor/Overview.html">EndpointDescriptor</a> & endpointDesc,
16     void * pBuffer,
17     size_t * pReceivedSize,
18     size_t bufferSize,
19     bit8 option = 0x00
20);
21</pre>
22    </div>
23<h2>Arguments</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29<th>Name</th>
30<td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34<td>in</td>
35<th>endpointDesc</th>
36<td>Descriptor indicating the endpoint to use. The port and sending source must be attached in advance using the <a href="../../../nn/uds/CTR/Attach.html"><CODE>Attach</CODE></a> function.</td>
37        </tr>
38        <tr>
39<td>out</td>
40<th>pBuffer</th>
41<td>Received data storage location. Specify a buffer aligned to 4 bytes.</td>
42        </tr>
43        <tr>
44<td>out</td>
45<th>pReceivedSize</th>
46<td>Size of the received data. The UDS maximum received data size is <a href="../../../nn/uds/CTR/UDS_PACKET_PAYLOAD_MAX_SIZE.html"><CODE>UDS_PACKET_PAYLOAD_MAX_SIZE</CODE></a> bytes.</td>
47        </tr>
48        <tr>
49<td>in</td>
50<th>bufferSize</th>
51<td>Size of the receive buffer (<SPAN class="argument">pBuffer</SPAN>).</td>
52        </tr>
53        <tr>
54<td>in</td>
55<th>option</th>
56<td>Receive options. Specifying <a href="../../../nn/uds/CTR/NO_WAIT.html"><CODE>NO_WAIT</CODE></a> here will cause the function to return immediately, even if no data has been received. If not specified, the function will not return until either it receives data or an error occurs.</td>
57        </tr> </table>
58    </div>
59<h2>Return Values</h2>
60<div class="section">Returns the function's execution result. </div>
61<h2>Description</h2>
62    <div class="section">
63<p>Receives data. (There is no way to obtain the address of the sender.)</p><!-- write here --></div>
64<h2>Revision History</h2>
65    <div class="section">
66      <dl class="history">
67        <dt>2010/09/24</dt>
68<dd>Noted that the buffer specified for <SPAN class="argument">pBuffer</SPAN> must be 4-byte aligned.
69        </dd>
70        <dt>2010/06/14</dt>
71<dd>Initial version.<br />
72        </dd>
73      </dl>
74    </div>
75  <hr><p>CONFIDENTIAL</p></body>
76</html>