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>GetNodeInformation</title>
8  </head>
9  <body>
10<h1><CODE>nn::uds::CTR::GetNodeInformation</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> GetNodeInformation(
15     <a href="../../../nn/uds/CTR/NodeInformation/Overview.html">NodeInformation</a> * pNodeInfo,
16     u16 nodeId
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>out</td>
32<th>pNodeInfo</th>
33<td>Node information. In a future implementation, this will be a structure corresponding to the stored data.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>nodeId</th>
38<td>Node ID for the targeted node.</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></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>ResultNotInitialized</th>
56<td>The library is not initialized. Execute the <CODE>nn::uds::Initialize</CODE> function.</td>
57        </tr>
58        <tr>
59<th>ResultInvalidNode</th>
60<td>The target node does not exist on the network. It is possible you are disconnected.</td>
61        </tr>
62        <tr>
63<th>ResultWirelessOff</th>
64<td>Transitioned to wireless OFF mode. Re-initialization is required.</td>
65        </tr>
66        <tr>
67<th>A value other than the above.</th>
68<td>Failed for reasons other than those given above.</td>
69        </tr>
70      </table> </div>
71<h2>Description</h2>
72    <div class="section">
73<p>Gets information about the specified node.</p><!-- write here --></div>
74<h2>Revision History</h2>
75    <div class="section">
76      <dl class="history">
77        <dt>2010/10/15</dt>
78<dd>Expanded the information on the return values. Changed the members of the <CODE>NodeInformation</CODE> structure. For details, see the reference for <CODE>NodeInformation</CODE>.
79        </dd>
80        <dt>2010/06/14</dt>
81<dd>Initial version.<br />
82        </dd>
83      </dl>
84    </div>
85  <hr><p>CONFIDENTIAL</p></body>
86</html>