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>SetApplicationDataToBeacon</title>
8  </head>
9  <body>
10<h1><CODE>nn::uds::CTR::SetApplicationDataToBeacon</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> SetApplicationDataToBeacon(
15     const void * pData,
16     size_t dataSize
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>pData</th>
33<td>Pointer to the data to set.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>dataSize</th>
38<td>Size of the data to set. Specify a value less than <a href="../../../nn/uds/CTR/NET_DESC_APPDATA_SIZE_MAX.html"><CODE>NET_DESC_APPDATA_SIZE_MAX</CODE></a>.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<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 />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>ResultSuccess</CODE></th>
52<td>Process was successful.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultNotInitialized</CODE></th>
56<td>The library is not initialized. Execute the <CODE>nn::uds::Initialize</CODE> function.</td>
57        </tr>
58        <tr>
59<th>ResultInvalidState</th>
60<td>Not in an executable state. Returned when executed in a state other than master.</td>
61        </tr>
62        <tr>
63<th>ResultTooLarge</th>
64<td><CODE>dataSize</CODE> exceeds <CODE>nn::uds::NET_DESC_APPDATA_SIZE_MAX</CODE>.</td>
65        </tr>
66        <tr>
67<th>ResultWirelessOff</th>
68<td>Transitioned to wireless OFF mode. Re-initialization is required.</td>
69        </tr>
70        <tr>
71<th>A value other than the above.</th>
72<td>Failed for reasons other than those given above.</td>
73        </tr>
74      </table> </div>
75<h2>Description</h2>
76    <div class="section">
77<p>Sets optional data in the beacon.</p><p>Sets any data up to a maximum of <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. Only the master can run this function.</p><!-- write here --></div>
78<h2>Revision History</h2>
79    <div class="section">
80      <dl class="history">
81        <dt>2010/10/15</dt>
82<dd>Expanded the information on the return values. Revised the Description to make it easier to understand.
83Indicated that the data is not encrypted wirelessly.<br />
84        </dd>
85        <dt>2010/06/14</dt>
86<dd>Initial version.<br />
87        </dd>
88      </dl>
89    </div>
90  <hr><p>CONFIDENTIAL</p></body>
91</html>
92