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>Attach</title>
8  </head>
9  <body>
10<h1><CODE>nn::uds::CTR::Attach</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> Attach(
15     <a href="../../../nn/uds/CTR/EndpointDescriptor/Overview.html">EndpointDescriptor</a> * pEndpointDesc,
16     u16 srcNodeId,
17     u8 port,
18     size_t receiveBufferSize = (<a href="../../../nn/uds/CTR/UDS_PACKET_PAYLOAD_MAX_SIZE.html">UDS_PACKET_PAYLOAD_MAX_SIZE</a> *8)
19);
20</pre>
21    </div>
22<h2>Arguments</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th>pEndpointDesc</th>
35<td>Descriptor indicating the endpoint to use.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>srcNodeId</th>
40<td>Node ID to attach. When <CODE>BROADCAST_NODE_ID</CODE> is specified, all nodes will be attached.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>port</th>
45<td>Port number to attach. Port number <CODE>0x00</CODE> is reserved by the system and cannot be used.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>receiveBufferSize</th>
50<td>Size of the receive buffer to allocate. This is allocated from the memory block allocated by the <a href="../../../nn/uds/CTR/Initialize.html"><CODE>Initialize</CODE></a> function, so take care that the total size of all receive buffers does not exceed the size of this allocated memory block. By default, a size of 8 times the <a href="../../../nn/uds/CTR/UDS_PACKET_PAYLOAD_MAX_SIZE.html"><CODE>UDS_PACKET_PAYLOAD_MAX_SIZE</CODE></a> data is allocated. When specifying the data size, choosing a multiple of 32 will yield the maximum efficiency. (Memory is allocated in 32-byte chunks.)</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the function's execution result. </div>
55<h2>Description</h2>
56    <div class="section">
57<p>Attaches the specified port and node ID to the descriptor. When doing so, the system creates a receive buffer for receiving data.</p><!-- write here --></div>
58<h2>Revision History</h2>
59    <div class="section">
60      <dl class="history">
61        <dt>2010/06/14</dt>
62<dd>Initial version.<br />
63        </dd>
64      </dl>
65    </div>
66  <hr><p>CONFIDENTIAL</p></body>
67</html>
68