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>nn::rdt::CTR::Sender::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/SenderConfig/Overview.html">SenderConfig</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>SenderConfig</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 following values may be returned: <CODE>ResultSuccess</CODE>, <a href="../../../../nn/rdt/CTR/ResultNullPointer/Overview.html"><CODE>ResultNullPointer</CODE></a>, <a href="../../../../nn/rdt/CTR/ResultInvalidSize/Overview.html"><CODE>ResultInvalidSize</CODE></a>, and <a href="../../../../nn/rdt/CTR/ResultAlreadyInitialized/Overview.html"><CODE>ResultAlreadyInitialized</CODE></a>, 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>nn::uds::EndpointDescriptor</CODE> objects are consumed implicitly within this function. If initialization fails, the function returns without consuming any <CODE>nn::uds::EndpointDescriptor</CODE> objects. The memory that is passed to the instance during this call must remain allocated until <a href="../../../../nn/rdt/CTR/Sender/Finalize.html"><CODE>Finalize</CODE></a> is called.</p><!-- write here --></div>
40<h2>Revision History</h2>
41    <div class="section">
42      <dl class="history">
43        <dt>2010/06/14</dt>
44<dd>Initial version.<br />
45        </dd>
46      </dl>
47    </div>
48  <hr><p>CONFIDENTIAL</p></body>
49</html>