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>CreateNetwork</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/uds/Overview.html">uds</a>::<a href="../../../nn/uds/CTR/Overview.html">CTR</a>::CreateNetwork</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> CreateNetwork(
15     <a href="../../../nn_types/u8.html">u8</a> subId,
16     <a href="../../../nn_types/u8.html">u8</a> maxEntry,
17     <a href="../../../nn_types/bit32.html">bit32</a> localId,
18     const char passphrase[],
19     size_t passphraseLength
20);
21
22<a href="../../../nn/Result/Overview.html">nn::Result</a> CreateNetwork(
23     <a href="../../../nn_types/u8.html">u8</a> subId,
24     <a href="../../../nn_types/u8.html">u8</a> maxEntry,
25     <a href="../../../nn_types/bit32.html">bit32</a> localId,
26     const char passphrase[],
27     size_t passphraseLength,
28     const void * pData,
29     size_t dataSize
30);
31
32<a href="../../../nn/Result/Overview.html">nn::Result</a> CreateNetwork(
33     <a href="../../../nn_types/u8.html">u8</a> subId,
34     <a href="../../../nn_types/u8.html">u8</a> maxEntry,
35     <a href="../../../nn_types/bit32.html">bit32</a> localId,
36     const char passphrase[],
37     size_t passphraseLength,
38     <a href="../../../nn_types/u8.html">u8</a> channel
39);
40
41<a href="../../../nn/Result/Overview.html">nn::Result</a> CreateNetwork(
42     <a href="../../../nn_types/u8.html">u8</a> subId,
43     <a href="../../../nn_types/u8.html">u8</a> maxEntry,
44     <a href="../../../nn_types/bit32.html">bit32</a> localId,
45     const char passphrase[],
46     size_t passphraseLength,
47     <a href="../../../nn_types/u8.html">u8</a> channel,
48     const void * pData,
49     size_t dataSize
50);
51</pre>
52    </div>
53<h2>List of Overloaded Member Functions</h2>
54    <div class="section">
55      <table class="members">
56        <tr>
57          <td>
58<a href="./CreateNetwork(0).html"><CODE>CreateNetwork(u8, u8, bit32, const char, size_t)</CODE> </a>
59          </td>
60<td>Creates a new network.</td>
61        </tr>
62        <tr>
63          <td>
64<a href="./CreateNetwork(1).html">CreateNetwork ( u8, u8, bit32, const char, size_t, const void *, size_t ) </a>
65          </td>
66<td>Sets optional data for the beacon and builds a new network.</td>
67        </tr>
68        <tr>
69          <td>
70<a href="./CreateNetwork(2).html"><CODE>CreateNetwork(u8, u8, bit32, const char, size_t, u8)</CODE> </a>
71          </td>
72<td>Creates a new network. This function is provided for debugging purposes and can be used to specify the channel to use for wireless communication during development. Note that the <SPAN class="argument">channel</SPAN> argument is ignored on production hardware.</td>
73        </tr>
74        <tr>
75          <td>
76<a href="./CreateNetwork(3).html">CreateNetwork ( u8, u8, bit32, const char, size_t, u8, const void *, size_t ) </a>
77          </td>
78<td>Sets optional data for the beacon and builds a new network. This function is provided for debugging purposes, and can be used to specify the channel to use for wireless communication during development. Note that the <SPAN class="argument">channel</SPAN> argument is ignored on production hardware.</td>
79        </tr> </table>
80    </div>
81<h2>Description of <CODE>CreateNetwork(u8, u8, bit32, const char, size_t)</CODE></h2>
82<div class="section"><p>Approximately 800 ms is required for completion, in order to then auto-select channels or perform similar processes.<br /><br /> This function is thread-safe.</p><!-- write here --></div>
83<h2>Description of <CODE> CreateNetwork ( u8, u8, bit32, const char, size_t, const void *, size_t )</CODE></h2>
84<div class="section"><p>Approximately 800 ms is needed to complete this because auto-selection of channels and other operations must be performed. </p><p>Using this <CODE>API</CODE> function allows you to set optional data for the beacon, when building the network. To update the optional data for the beacon after the network has been constructed, use the <CODE><a href="../../../nn/uds/CTR/SetApplicationDataToBeacon.html">SetApplicationDataToBeacon</a></CODE> function. The maximum size of this optional data is <CODE><a href="../../../nn/uds/CTR/NET_DESC_APPDATA_SIZE_MAX.html">NET_DESC_APPDATA_SIZE_MAX</a></CODE> bytes. Since it is not encrypted, note that it can be collected by any general device, such as a computer. Other devices can obtain this data by calling <CODE><A>Scan</A></CODE>, while they are connected as clients or spectators. This function is thread-safe.</p><!-- write here --></div>
85<h2>Description of <CODE>CreateNetwork(u8, u8, bit32, const char, size_t, u8)</CODE></h2>
86<div class="section"><p>Approximately 800 ms is required for completion, in order to then auto-select channels or perform similar processes.<br /><br /> This function is thread-safe.</p><!-- write here --></div>
87<h2>Description of <CODE>CreateNetwork ( u8, u8, bit32, const char, size_t, u8, const void *, size_t )</CODE></h2>
88<div class="section"><p>Approximately 800 ms is needed to complete this, because auto-selection of channels and other operations must be performed.</p><p>Using this <CODE>API</CODE> function allows you to set optional data for the beacon, when building the network. To update the optional data for the beacon after the network has been constructed, use the <CODE><a href="../../../nn/uds/CTR/SetApplicationDataToBeacon.html">SetApplicationDataToBeacon</a></CODE> function. The maximum size of this optional data is <CODE><a href="../../../nn/uds/CTR/NET_DESC_APPDATA_SIZE_MAX.html">NET_DESC_APPDATA_SIZE_MAX</a></CODE> bytes. Since it is not encrypted, note that it can be collected by any general device, such as a computer. Other devices can obtain this data by calling <CODE><A>Scan</A></CODE>, while they are connected as clients or spectators. This function is thread-safe.</p><!-- write here --></div>
89  <hr><p>CONFIDENTIAL</p></body>
90</html>