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 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 span.virtual_style 22 { 23 font-size : 8pt; 24 color : white; 25 font-weight : bold; 26 background : #0a0; 27 border-left : solid 1px #0f0; 28 border-top : solid 1px #0f0; 29 border-right : solid 1px #060; 30 border-bottom : solid 1px #060; 31 padding-left : 2px; 32 padding-right : 2px; 33 } 34 span.protected_style 35 { 36 font-size : 8pt; 37 color : white; 38 font-weight : bold; 39 background : #444; 40 border-left : solid 1px #ccc; 41 border-top : solid 1px #ccc; 42 border-right : solid 1px #222; 43 border-bottom : solid 1px #222; 44 padding-left : 2px; 45 padding-right : 2px; 46 } 47 --></style> 48<title>nn::uds::CTR::NetworkDescription</title> 49 </head> 50 <body> 51<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>::NetworkDescription</CODE> Class</h1> 52<h2>Syntax</h2> 53 <div class="section"> 54<pre class="definition">class NetworkDescription</pre> 55 </div> 56<h2>Description</h2> 57 <div class="section"> 58<p>Class indicating network information that can be obtained using <a href="../../../../nn/uds/CTR/NetworkDescriptionReader/Overview.html"><CODE>nn::uds::CTR::NetworkDescriptionReader</CODE></a>.</p><!-- write here --></div> 59 <a name="function" id="function"> 60<h2>Member Functions</h2> 61 <div class="section"> 62 <table class="members"> 63 <tr> 64 <td width="100"> </td> 65 <th> 66<a href="../../../../nn/uds/CTR/NetworkDescription/GetBssid.html"><CODE>GetBssid</CODE></a> 67 </th> 68<td>Gets the BSSID (the master's MAC address).</td> 69 </tr> 70 <tr> 71 <td width="100"> </td> 72 <th> 73<a href="../../../../nn/uds/CTR/NetworkDescription/GetGameId.html"><CODE>GetGameId</CODE></a> 74 </th> 75<td>Gets the local communication ID. This function is identical to <a href="../../../../nn/uds/CTR/NetworkDescription/GetLocalCommunicationId.html"><CODE>GetLocalCommunicationId</CODE></a> and is preserved to maintain compatibility.</td> 76 </tr> 77 <tr> 78 <td width="100"> </td> 79 <th> 80<a href="../../../../nn/uds/CTR/NetworkDescription/GetLocalCommunicationId.html"><CODE>GetLocalCommunicationId</CODE></a> 81 </th> 82<td>Gets the local communication ID. This is identical to the value specified with the <a href="../../../../nn/uds/CTR/Scan.html"><CODE>Scan</CODE></a> function.</td> 83 </tr> 84 <tr> 85 <td width="100"> </td> 86 <th> 87<a href="../../../../nn/uds/CTR/NetworkDescription/GetSubId.html"><CODE>GetSubId</CODE></a> 88 </th> 89<td>Gets the <CODE>SubId</CODE>.</td> 90 </tr> 91 <tr> 92 <td width="100"> </td> 93 <th> 94<a href="../../../../nn/uds/CTR/NetworkDescription/GetTemporaryId.html"><CODE>GetTemporaryId</CODE></a> 95 </th> 96<td>Gets the temporary ID. This ID can be used to identify the network, but for that we recommend that you use the BSSID or the master's <a href="../../../../nn/uds/CTR/NodeInformation/Overview.html"><CODE>NodeInformation</CODE></a> instead.</td> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101<a href="../../../../nn/uds/CTR/NetworkDescription/GetChannel.html"><CODE>GetChannel</CODE></a> 102 </th> 103<td>Gets the channel being used for the communication. There is normally no need to reference this.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108<a href="../../../../nn/uds/CTR/NetworkDescription/GetNowEntry.html"><CODE>GetNowEntry</CODE></a> 109 </th> 110<td>Gets the number of currently connected devices.</td> 111 </tr> 112 <tr> 113 <td width="100"> </td> 114 <th> 115<a href="../../../../nn/uds/CTR/NetworkDescription/GetMaxEntry.html"><CODE>GetMaxEntry</CODE></a> 116 </th> 117<td>Gets the maximum number of devices that can connect.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122<a href="../../../../nn/uds/CTR/NetworkDescription/GetApplicationData.html"><CODE>GetApplicationData</CODE></a> 123 </th> 124<td>Gets the data set using the <a href="../../../../nn/uds/CTR/SetApplicationDataToBeacon.html"><CODE>SetApplicationDataToBeacon</CODE></a> function.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129<a href="../../../../nn/uds/CTR/NetworkDescription/CanConnectAsSpectator.html"><CODE>CanConnectAsSpectator</CODE></a> 130 </th> 131<td>Checks whether Spectator connections are allowed.</td> 132 </tr> 133 <tr> 134 <td width="100"> </td> 135 <th> 136<a href="../../../../nn/uds/CTR/NetworkDescription/CanConnectAsClient.html"><CODE>CanConnectAsClient</CODE></a> 137 </th> 138<td>Checks whether client connections are allowed.</td> 139 </tr> 140 <tr> 141 <td width="100"> </td> 142 <th> 143<a href="../../../../nn/uds/CTR/NetworkDescription/CanReconnectAsClient.html"><CODE>CanReconnectAsClient</CODE></a> 144 </th> 145<td>Checks whether client reconnections are allowed. The decision whether to reconnect is made by the master when the client actually connects, so reconnection is not guaranteed even if this value is <CODE>true</CODE>.</td> 146 </tr> 147 <tr> 148 <td width="100"> </td> 149 <th> 150<a href="../../../../nn/uds/CTR/NetworkDescription/operator==.html"><CODE>operator==</CODE></a> 151 </th> 152<td>Compares two <CODE><a href="../../../../nn/uds/CTR/NetworkDescription/Overview.html">NetworkDescription</a></CODE> class objects and returns <CODE>true</CODE> if their values are identical. Even if the network is the same, <CODE>false</CODE> is returned if data has been set by <CODE>SetApplicationData</CODE> or if the number of connected devices is different.</td> 153 </tr> 154 <tr> 155 <td width="100"> </td> 156 <th> 157<a href="../../../../nn/uds/CTR/NetworkDescription/operator!=.html"><CODE>operator!=</CODE></a> 158 </th> 159<td>Compares two <CODE><a href="../../../../nn/uds/CTR/NetworkDescription/Overview.html">NetworkDescription</a></CODE> class objects and returns <CODE>true</CODE> if their values are different. Even if the network is the same, <CODE>true</CODE> is returned if data has been set by <CODE>SetApplicationData</CODE> or if the number of connected devices is different.</td> 160 </tr> </table> 161 </div> 162 </a> 163<h2>Revision History</h2> 164 <div class="section"> 165 <dl class="history"> 166 <dt>2010/06/14</dt> 167<dd>Initial version.<br /> 168 </dd> 169 </dl> 170 </div> 171 <hr><p>CONFIDENTIAL</p></body> 172</html> 173