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>Initialize</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/rdt/Overview.html">rdt</a>::<a href="../../../../nn/rdt/CTR/Overview.html">CTR</a>::<a href="../../../../nn/rdt/CTR/Receiver/Overview.html">Receiver</a>::Initialize</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> Initialize(
15     const <a href="../../../../nn/rdt/CTR/ReceiverConfig/Overview.html">ReceiverConfig</a> & config
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>in</td>
31<th>config</th>
32<td>Structure that contains the initialization parameters. See <CODE>ReceiverConfig</CODE> for more details.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36<div class="section">Returns the result of initialization. Specifically, the value of the <CODE><a href="../../../../nn/Result/IsSuccess.html">nn::Result::IsSuccess</a></CODE> function, <CODE><a href="../../../../nn/rdt/CTR/ResultAlreadyInitialized/Overview.html">ResultAlreadyInitialized</a></CODE>, <CODE><a href="../../../../nn/rdt/CTR/ResultNullPointer/Overview.html">ResultNullPointer</a></CODE> and  <CODE><a href="../../../../nn/rdt/CTR/ResultInvalidSize/Overview.html">ResultInvalidSize</a></CODE> might be returned, as well as other result codes that can be returned by the UDS API. </div>
37<h2>Description</h2>
38    <div class="section">
39<p>Initializes an instance.</p><p>If initialization succeeds, two <CODE><a href="../../../../nn/uds/CTR/EndpointDescriptor/Overview.html">nn::uds::CTR::EndpointDescriptor</a></CODE> objects are consumed implicitly within this function. If initialization fails, the function returns without consuming any <CODE><a href="../../../../nn/uds/CTR/EndpointDescriptor/Overview.html">nn::uds::CTR::EndpointDescriptor</a></CODE> objects. The memory that is passed to this instance during this call must remain allocated until <a href="../../../../nn/rdt/CTR/Receiver/Finalize.html"><CODE>Finalize</CODE></a> is called.</p><p>Internally, <CODE><a href="../../../../nn/uds/CTR/Attach.html">nn::uds::CTR::Attach</a></CODE> is called implicitly with <CODE><a href="../../../../nn/uds/CTR/ATTACH_BUFFER_SIZE_DEFAULT.html">nn::uds::CTR::ATTACH_BUFFER_SIZE_DEFAULT</a></CODE> specified for the size of the receive buffer. Because <CODE>nn::uds::CTR::Attach</CODE> utilizes the buffer passed to the <CODE><a href="../../../../nn/uds/CTR/Initialize.html">nn::uds::CTR::Initialize</a></CODE> function, if the application did not give a buffer of sufficient size to <CODE>nn::uds::CTR::Initialize</CODE> the function will return <CODE><a href="../../../../nn/uds/CTR/ResultOutOfResource/Overview.html">nn::uds::CTR::ResultOutOfResource</a></CODE> and initialization will fail.</p><!-- write here --></div>
40<h2>Revision History</h2>
41    <div class="section">
42      <dl class="history">
43        <dt>2011/06/09</dt>
44<dd>Added a note that internally the <CODE>nn::uds::CTR::Attach</CODE> function is called implicitly.<br />
45        </dd>
46        <dt>2010/06/14</dt>
47<dd>Initial version.<br />
48        </dd>
49      </dl>
50    </div>
51  <hr><p>CONFIDENTIAL</p></body>
52</html>
53