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>EjectSpectator</title>
8  </head>
9  <body>
10<h1><CODE>nn::uds::CTR::EjectSpectator</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> EjectSpectator(
15     void
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21<p>None.</p>
22    </div>
23<h2>Return Values</h2>
24<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 />
25      <table class="arguments">
26        <thead>
27          <tr>
28<th>Value</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<th><CODE>ResultSuccess</CODE></th>
34<td>Process was successful.</td>
35        </tr>
36        <tr>
37<th><CODE>ResultNotInitialized</CODE></th>
38<td>The library is not initialized. Execute the <CODE>nn::uds::Initialize</CODE> function.</td>
39        </tr>
40        <tr>
41<th>ResultInvalidState</th>
42<td>Not in an executable state. Returned when executed in a state other than master.</td>
43        </tr>
44        <tr>
45<th>ResultWirelessOff</th>
46<td>Transitioned to wireless OFF mode. Re-initialization is required.</td>
47        </tr>
48        <tr>
49<th>A value other than the above.</th>
50<td>Failed for reasons other than those given above.</td>
51        </tr>
52      </table> </div>
53<h2>Description</h2>
54    <div class="section">
55<p>Kicks all the connected spectators off of the network.</p><p>New spectators will be unable to connect after you execute this function. To allow Spectator nodes to connect again, call the <a href="../../../nn/uds/CTR/AllowToSpectate.html"><CODE>AllowToSpectate</CODE></a> function. Only the master can run this function.</p><!-- write here --></div>
56<h2>Revision History</h2>
57    <div class="section">
58      <dl class="history">
59        <dt>2010/10/15</dt>
60<dd>Expanded the information on the return values. Revised the Description to make it easier to understand.<br />
61        </dd>
62        <dt>2010/09/17</dt>
63<dd>In the past, the signal strength sometimes made it impossible to eject Spectator nodes. The specifications were changed so that Spectator nodes are prevented from connecting after this function is run, thereby eliminating Spectator nodes from the network.
64        </dd>
65        <dt>2010/08/16</dt>
66<dd>Initial version.<br />
67        </dd>
68      </dl>
69    </div>
70  <hr><p>CONFIDENTIAL</p></body>
71</html>
72