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>GetApplicationDataFromBeacon</title>
8  </head>
9  <body>
10<h1><CODE>nn::uds::CTR::GetApplicationDataFromBeacon</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> GetApplicationDataFromBeacon(
15     void * pBuffer,
16     size_t * pDataSize,
17     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>pBuffer</th>
34<td>Data storage location.</td>
35        </tr>
36        <tr>
37<td>out</td>
38<th>pDataSize</th>
39<td>Data size.</td>
40        </tr>
41        <tr>
42<td>in</td>
43<th>bufferSize</th>
44<td>Buffer size. Specify <a href="../../../nn/uds/CTR/NET_DESC_APPDATA_SIZE_MAX.html"><CODE>NET_DESC_APPDATA_SIZE_MAX</CODE></a> bytes for the most part; the amount of data that can be received can be changed as you like.</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>ResultSuccess</th>
58<td>Process was successful.</td>
59        </tr>
60        <tr>
61<th>ResultNotInitialized</th>
62<td>The library is not initialized. Execute the <CODE>nn::uds::Initialize</CODE> function.</td>
63        </tr>
64        <tr>
65<th>ResultInvalidState</th>
66<td>Not in an executable state. Returns that it was executed in a state where it was not connected to the network.</td>
67        </tr>
68        <tr>
69<th>ResultTooLarge</th>
70<td>Returns that the <CODE>bufferSize</CODE> was smaller than the received data. The desired size is <CODE>nn::uds::NET_DESC_APPDATA_SIZE_MAX</CODE>.</td>
71        </tr>
72        <tr>
73<th>ResultWirelessOff</th>
74<td>Transitioned to wireless OFF mode. Re-initialization is required.</td>
75        </tr>
76        <tr>
77<th>A value other than the above.</th>
78<td>Failed for reasons other than those given above.</td>
79        </tr>
80      </table> </div>
81<h2>Description</h2>
82    <div class="section">
83<p>Gets the data set to the beacon.</p><p>The master gets the data set using the <a href="../../../../nn/uds/CTR/SetApplicationDataToBeacon.html"><CODE>SetApplicationDataToBeacon</CODE></a> function. This can only be run when connected to network. Note that there is no notification if the data is updated.</p><!-- write here --></div>
84<h2>Revision History</h2>
85    <div class="section">
86      <dl class="history">
87        <dt>2010/10/15</dt>
88<dd>Expanded the information on the return values. Revised the Description to make it easier to understand.<br />
89        </dd>
90        <dt>2010/06/14</dt>
91<dd>Initial version.<br />
92        </dd>
93      </dl>
94    </div>
95  <hr><p>CONFIDENTIAL</p></body>
96</html>
97