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>ConnectNetwork</title>
8  </head>
9  <body>
10<h1><CODE>nn::uds::CTR::ConnectNetwork</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> ConnectNetwork(
15     const <a href="../../../nn/uds/CTR/NetworkDescription/Overview.html">NetworkDescription</a> & networkDescription,
16     <a href="../../../nn/uds/CTR/ConnectType.html">ConnectType</a> type,
17     const char passphrase[],
18     size_t passphraseLength
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>networkDescription</th>
35<td>Network information. Obtained from scanning results.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>type</th>
40<td>Connection type.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>passphrase[]</th>
45<td>Passphrase to use for wireless layer encryption. With UDS, communication can only be established if the <SPAN class="argument">uniqueId</SPAN> and <SPAN class="argument">passphrase</SPAN> match.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>passphraseLength</th>
50<td>Passphrase length. Specify a value smaller than 255 (provisional specification).</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<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 />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>ResultSuccess</CODE></th>
64<td>Connection succeeded and operations began for the specified connection type.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultNotInitialized</CODE></th>
68<td>The library is not initialized. Execute the <CODE>nn::uds::Initialize</CODE> function.</td>
69        </tr>
70        <tr>
71<th>ResultNotFoundNetwork</th>
72<td>The connection target network was not found: Returned when the network has already been destroyed or when it is outside the range of communications.</td>
73        </tr>
74        <tr>
75<th>ResultAlreadyNetworkIsFull</th>
76<td>The number of network nodes has already reached the maximum number of connections. You will be unable to connect unless you reduce the number of nodes.</td>
77        </tr>
78        <tr>
79<th>ResultDeniedFromMaster</th>
80<td>Connection was denied by the master. Returned when the master has denied connection. Also returned when the passphrase is in error.</td>
81        </tr>
82        <tr>
83<th>ResultConnectionTimeout</th>
84<td>A connection was not established within a set time. Returned when the signal strength is bad or when there is excessive load on the master.</td>
85        </tr>
86        <tr>
87<th>ResultInvalidState</th>
88<td>Not in an executable state. Returned when executed in a state other than <CODE>STATE_DISCONNECTED</CODE>.</td>
89        </tr>
90        <tr>
91<th>ResultOutOfRange</th>
92<td>The specified argument was not in a specifiable range. It is possible it will succeed if you re-execute with an appropriate value for the argument.</td>
93        </tr>
94        <tr>
95<th>ResultWirelessOff</th>
96<td>Transitioned to wireless OFF mode. Re-initialization is required.</td>
97        </tr>
98        <tr>
99<th>A value other than the above.</th>
100<td>Failed for reasons other than those given above.</td>
101        </tr>
102      </table> </div>
103<h2>Description</h2>
104    <div class="section">
105<p>Connects to an existing network.</p><!-- write here --></div>
106<h2>Revision History</h2>
107    <div class="section">
108      <dl class="history">
109        <dt>2010/10/15</dt>
110<dd>Expanded the information on the return values.<br />
111        </dd>
112        <dt>2010/06/14</dt>
113<dd>Initial version.<br />
114        </dd>
115      </dl>
116    </div>
117  <hr><p>CONFIDENTIAL</p></body>
118</html>
119