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::uds::CTR::Initialize</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> Initialize(
15     <a href="../../../nn/os/Event/Overview.html">nn::os::Event</a> * pStatusUpdateEvent,
16     void * receiveBuffer,
17     const size_t bufferSize
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>pStatusUpdateEvent</th>
34<td>Event used to notify about connection state updates. This is initialized as an auto-reset event within the library.</td>
35        </tr>
36        <tr>
37<td>in</td>
38<th>receiveBuffer</th>
39<td>Pointer indicating the head of the receive buffer used by the UDS library. Specify a buffer aligned to 4096 bytes. Device memory cannot be used. Access to the memory region specified by the buffer is prohibited until the <CODE><A>Finalize</A></CODE> function's execution is complete.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>bufferSize</th>
44<td>Size of the receive buffer. Specify a value that is a multiple of 4096.</td>
45        </tr> </table>
46    </div>
47<h2>Return Values</h2>
48<div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
49      <table class="arguments">
50        <thead>
51          <tr>
52<th>Value</th>
53<td>Description</td>
54          </tr>
55        </thead>
56        <tr>
57<th><CODE>ResultSuccess</CODE></th>
58<td>Initialization successful.</td>
59        </tr>
60        <tr>
61<th>ResultAlreadyOccupiedWirelessDevice</th>
62<td>Communication is already taking place. New UDS communication cannot begin.</td>
63        </tr>
64        <tr>
65<th>ResultOutOfResource</th>
66<td>System resources are insufficient.</td>
67        </tr>
68        <tr>
69<th>ResultWirelessOff</th>
70<td>Wireless OFF mode.</td>
71        </tr>
72      </table> </div>
73<h2>Description</h2>
74    <div class="section">
75<p>Initializes the UDS library. Initialization fails if any other communication features are already in use.</p><p>This function may block for a long time because it finalizes communications in the background and the UDS library takes control of the communication device until <a href="../../../nn/uds/CTR/Finalize.html"><CODE>Finalize</CODE></a> is run.</p><!-- write here --></div>
76<h2>Revision History</h2>
77    <div class="section">
78      <dl class="history">
79        <dt>2010/10/15</dt>
80<dd>Expanded the information on the return values. Revised the Description to make it easier to understand.<br />
81        </dd>
82        <dt>2010/09/27</dt>
83<dd>Eliminated text from the description of <SPAN class="argument">receiveBuffer</SPAN> related to its purpose and noted that applications are prohibited from accessing the specified memory region until <CODE>Finalize</CODE> completes.
84        </dd>
85        <dt>2010/09/18</dt>
86<dd>Noted that this function may take some time to complete.
87        </dd>
88        <dt>2010/06/14</dt>
89<dd>Initial version.<br />
90        </dd>
91      </dl>
92    </div>
93  <hr><p>CONFIDENTIAL</p></body>
94</html>
95