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 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::uds::CTR::NetworkDescription</title> 51 </head> 52 <body> 53<h1><CODE>nn::uds::CTR::NetworkDescription</CODE> Class</h1> 54<h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">class NetworkDescription</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<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> 61 <a name="function" id="function"> 62<h2>Member Functions</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> </td> 67 <th> 68<a href="../../../../nn/uds/CTR/NetworkDescription/GetBssid.html"><CODE>GetBssid</CODE></a> 69 </th> 70<td>Gets the BSSID (the master device's MAC address).</td> 71 </tr> 72 <tr> 73 <td width="100"> </td> 74 <th> 75<a href="../../../../nn/uds/CTR/NetworkDescription/GetGameId.html"><CODE>GetGameId</CODE></a> 76 </th> 77<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> 78 </tr> 79 <tr> 80 <td width="100"> </td> 81 <th> 82<a href="../../../../nn/uds/CTR/NetworkDescription/GetLocalCommunicationId.html"><CODE>GetLocalCommunicationId</CODE></a> 83 </th> 84<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> 85 </tr> 86 <tr> 87 <td width="100"> </td> 88 <th> 89<a href="../../../../nn/uds/CTR/NetworkDescription/GetSubId.html"><CODE>GetSubId</CODE></a> 90 </th> 91<td>Gets the <CODE>SubId</CODE>.</td> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96<a href="../../../../nn/uds/CTR/NetworkDescription/GetTemporaryId.html"><CODE>GetTemporaryId</CODE></a> 97 </th> 98<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> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103<a href="../../../../nn/uds/CTR/NetworkDescription/GetChannel.html"><CODE>GetChannel</CODE></a> 104 </th> 105<td>Gets the channel being used for the communication. There is normally no need to reference this.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110<a href="../../../../nn/uds/CTR/NetworkDescription/GetNowEntry.html"><CODE>GetNowEntry</CODE></a> 111 </th> 112<td>Gets the number of currently connected devices.</td> 113 </tr> 114 <tr> 115 <td width="100"> </td> 116 <th> 117<a href="../../../../nn/uds/CTR/NetworkDescription/GetMaxEntry.html"><CODE>GetMaxEntry</CODE></a> 118 </th> 119<td>Gets the maximum number of devices that can connect.</td> 120 </tr> 121 <tr> 122 <td width="100"> </td> 123 <th> 124<a href="../../../../nn/uds/CTR/NetworkDescription/GetApplicationData.html"><CODE>GetApplicationData</CODE></a> 125 </th> 126<td>Gets the data set using the <a href="../../../../nn/uds/CTR/SetApplicationDataToBeacon.html"><CODE>SetApplicationDataToBeacon</CODE></a> function.</td> 127 </tr> 128 <tr> 129 <td width="100"> </td> 130 <th> 131<a href="../../../../nn/uds/CTR/NetworkDescription/CanConnectAsSpectator.html"><CODE>CanConnectAsSpectator</CODE></a> 132 </th> 133<td>Checks whether Spectator connections are allowed.</td> 134 </tr> 135 <tr> 136 <td width="100"> </td> 137 <th> 138<a href="../../../../nn/uds/CTR/NetworkDescription/operator==.html"><CODE>operator ==</CODE></a> 139 </th> 140<td>Compares two objects in the <CODE>NetworkDescription</CODE> class, and returns <CODE>true</CODE> if their values are the same. Even if the network is the same, it will return <CODE>false</CODE> if data has been set by <CODE>SetApplicationData</CODE> or due to [differences in] the number of connected devices.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145<a href="../../../../nn/uds/CTR/NetworkDescription/operator!=.html"><CODE>operator !=</CODE></a> 146 </th> 147<td>Compares two objects in the <CODE>NetworkDescription</CODE> class, and returns <CODE>true</CODE> if their values are <U>not</U> the same. Even if the network is the same, it will return <CODE>false</CODE> if data has been set by <CODE>SetApplicationData</CODE> or due to [differences in] the number of connected devices.</td> 148 </tr> </table> 149 </div> 150 </a> 151<h2>Revision History</h2> 152 <div class="section"> 153 <dl class="history"> 154 <dt>2010/06/14</dt> 155<dd>Initial version.<br /> 156 </dd> 157 </dl> 158 </div> 159 <hr><p>CONFIDENTIAL</p></body> 160</html>