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::friends::CTR</title> 49 </head> 50 <body> 51<h1><CODE>nn::friends::CTR</CODE> Namespace</h1> 52<h2>Description</h2> 53 <div class="section"> 54<p>The CTR FRIENDS namespace. <br />(This can also be written without the <CODE>::CTR</CODE> portion.)</p><!-- write here --></div> 55 <a name="enum" id="enum"> 56<h2>Enumerated Types</h2> 57 <div class="section"> 58 <table class="members"> 59 <tr> 60 <td width="100"> </td> 61 <th> 62<a href="../../../nn/friends/CTR/PlatformCode.html"><CODE>PlatformCode</CODE></a> 63 </th> 64<td>Enumerated type representing platform types.</td> 65 </tr> 66 <tr> 67 <td width="100"> </td> 68 <th> 69<a href="../../../nn/friends/CTR/AttributeFlag.html"><CODE>AttributeFlag</CODE></a> 70 </th> 71<td>Enumerated type representing friend relationships using attribute flags.</td> 72 </tr> 73 <tr> 74 <td width="100"> </td> 75 <th> 76<a href="../../../nn/friends/CTR/NotificationType.html"><CODE>NotificationType</CODE></a> 77 </th> 78<td>Enumerated type representing notification types.</td> 79 </tr> 80 <tr> 81 <td width="100"> </td> 82 <th> 83<a href="../../../nn/friends/CTR/NotificationMask.html"><CODE>NotificationMask</CODE></a> 84 </th> 85<td>Enumerated type representing notification bitmasks.</td> 86 </tr> </table> 87 </div> 88 </a> <a name="typedef" id="typedef"> 89<h2><CODE>typedef</CODE> Definitions</h2> 90 <div class="section"> 91 <table class="members"> 92 <tr> 93 <td width="100" /> 94 <th> 95<a href="../../../nn/friends/CTR/PrincipalId.html"><CODE>PrincipalId</CODE></a> 96 </th> 97<td>Represents a principal ID.</td> 98 </tr> 99 <tr> 100 <td width="100" /> 101 <th> 102<a href="../../../nn/friends/CTR/LocalFriendCode.html"><CODE>LocalFriendCode</CODE></a> 103 </th> 104<td>Represents a local friend code.</td> 105 </tr> 106 <tr> 107 <td width="100" /> 108 <th> 109<a href="../../../nn/friends/CTR/FriendKey.html"><CODE>FriendKey</CODE></a> 110 </th> 111<td>Structure for comprehensively handling users' principal IDs and local friend codes.</td> 112 </tr> 113 <tr> 114 <td width="100" /> 115 <th> 116<a href="../../../nn/friends/CTR/Profile.html"><CODE>Profile</CODE></a> 117 </th> 118<td>Structure storing a user's profile information.</td> 119 </tr> 120 <tr> 121 <td width="100" /> 122 <th> 123<a href="../../../nn/friends/CTR/MiiData.html"><CODE>MiiData</CODE></a> 124 </th> 125<td>Structure storing Mii data.</td> 126 </tr> 127 <tr> 128 <td width="100" /> 129 <th> 130<a href="../../../nn/friends/CTR/GameMode.html"><CODE>GameMode</CODE></a> 131 </th> 132<td>Structure storing information about the game the local host is currently playing. This information is required for friends to join in.</td> 133 </tr> 134 <tr> 135 <td width="100" /> 136 <th> 137<a href="../../../nn/friends/CTR/MyPresence.html"><CODE>MyPresence</CODE></a> 138 </th> 139<td>Structure storing the local user's presence information.</td> 140 </tr> 141 <tr> 142 <td width="100" /> 143 <th> 144<a href="../../../nn/friends/CTR/FriendPresence.html"><CODE>FriendPresence</CODE></a> 145 </th> 146<td>Structure storing friend presence information.</td> 147 </tr> 148 <tr> 149 <td width="100" /> 150 <th> 151<a href="../../../nn/friends/CTR/EventNotification.html"><CODE>EventNotification</CODE></a> 152 </th> 153<td>Structure storing notifications of changes in the local host's online state and friends' online states.</td> 154 </tr> </table> 155 </div> 156 </a> <a name="constant" id="constant"> 157<h2>Constants</h2> 158 <div class="section"> 159 <table class="members"> 160 <tr> 161 <td width="100"> 162<span class="static_style" title="static">S</span> 163 </td> 164 <th> 165<span class="argument"><a href="../../../nn/friends/CTR/INVALID_PRINCIPAL_ID.html"><CODE>INVALID_PRINCIPAL_ID</CODE></a></span> 166 </th> 167<td>Invalid principal ID.</td> 168 </tr> 169 <tr> 170 <td width="100"> 171<span class="static_style" title="static">S</span> 172 </td> 173 <th> 174<span class="argument"><a href="../../../nn/friends/CTR/INVALID_LOCAL_FRIEND_CODE.html"><CODE>INVALID_LOCAL_FRIEND_CODE</CODE></a></span> 175 </th> 176<td>Invalid local friend code.</td> 177 </tr> 178 <tr> 179 <td width="100"> 180<span class="static_style" title="static">S</span> 181 </td> 182 <th> 183<span class="argument"><a href="../../../nn/friends/CTR/SCREEN_NAME_SIZE.html"><CODE>SCREEN_NAME_SIZE</CODE></a></span> 184 </th> 185<td>The number of elements in the buffer for the screen name. Includes the terminating character.</td> 186 </tr> 187 <tr> 188 <td width="100"> 189<span class="static_style" title="static">S</span> 190 </td> 191 <th> 192<span class="argument"><a href="../../../nn/friends/CTR/MODE_DESCRIPTION_SIZE.html"><CODE>MODE_DESCRIPTION_SIZE</CODE></a></span> 193 </th> 194<td>The number of elements in the buffer for the game mode description string. Includes the terminating character.</td> 195 </tr> 196 <tr> 197 <td width="100"> 198<span class="static_style" title="static">S</span> 199 </td> 200 <th> 201<span class="argument"><a href="../../../nn/friends/CTR/MII_SIZE.html"><CODE>MII_SIZE</CODE></a></span> 202 </th> 203<td>The size of the Mii character binary data.</td> 204 </tr> 205 <tr> 206 <td width="100"> 207<span class="static_style" title="static">S</span> 208 </td> 209 <th> 210<span class="argument"><a href="../../../nn/friends/CTR/FRIEND_LIST_SIZE.html"><CODE>FRIEND_LIST_SIZE</CODE></a></span> 211 </th> 212<td>The size of the friend list. This is the maximum number of users that can be registered to the friend list.</td> 213 </tr> </table> 214 </div> 215 </a> <a name="function" id="function"> 216<h2>Functions</h2> 217 <div class="section"> 218 <table class="members"> 219 <tr> 220 <td width="100"> </td> 221 <th> 222<a href="../../../nn/friends/CTR/Initialize.html"><CODE>Initialize</CODE></a> 223 </th> 224<td>Initializes the friend presence library and makes presence features available for use.</td> 225 </tr> 226 <tr> 227 <td width="100"> </td> 228 <th> 229<a href="../../../nn/friends/CTR/Finalize.html"><CODE>Finalize</CODE></a> 230 </th> 231<td>Finalizes the friend presence library.</td> 232 </tr> 233 <tr> 234 <td width="100"> </td> 235 <th> 236<a href="../../../nn/friends/CTR/IsInitialized.html"><CODE>IsInitialized</CODE></a> 237 </th> 238<td>Determines whether the friend presence library has been initialized.</td> 239 </tr> 240 <tr> 241 <td width="100"> </td> 242 <th> 243<a href="../../../nn/friends/CTR/HasLoggedIn.html"><CODE>HasLoggedIn</CODE></a> 244 </th> 245<td>Checks this application's login state.</td> 246 </tr> 247 <tr> 248 <td width="100"> </td> 249 <th> 250<a href="../../../nn/friends/CTR/Login.html"><CODE>Login</CODE></a> 251 </th> 252<td>Requests a login to the server.</td> 253 </tr> 254 <tr> 255 <td width="100"> </td> 256 <th> 257<a href="../../../nn/friends/CTR/Logout.html"><CODE>Logout</CODE></a> 258 </th> 259<td>Retracts a login request to a server.</td> 260 </tr> 261 <tr> 262 <td width="100"> </td> 263 <th> 264<a href="../../../nn/friends/CTR/GetMyPrincipalId.html"><CODE>GetMyPrincipalId</CODE></a> 265 </th> 266<td>Gets the local host's principal ID.</td> 267 </tr> 268 <tr> 269 <td width="100"> </td> 270 <th> 271<a href="../../../nn/friends/CTR/GetMyPreference.html"><CODE>GetMyPreference</CODE></a> 272 </th> 273<td>Gets the disclosure level of the local host's information.</td> 274 </tr> 275 <tr> 276 <td width="100"> </td> 277 <th> 278<a href="../../../nn/friends/CTR/GetMyProfile.html"><CODE>GetMyProfile</CODE></a> 279 </th> 280<td>Gets the local host's profile information.</td> 281 </tr> 282 <tr> 283 <td width="100"> </td> 284 <th> 285<a href="../../../nn/friends/CTR/GetMyPresence.html"><CODE>GetMyPresence</CODE></a> 286 </th> 287<td>Gets the local host's presence information.</td> 288 </tr> 289 <tr> 290 <td width="100"> </td> 291 <th> 292<a href="../../../nn/friends/CTR/GetMyScreenName.html"><CODE>GetMyScreenName</CODE></a> 293 </th> 294<td>Obtains the user's own screen name.</td> 295 </tr> 296 <tr> 297 <td width="100"> </td> 298 <th> 299<a href="../../../nn/friends/CTR/GetMyMii.html"><CODE>GetMyMii</CODE></a> 300 </th> 301<td>Gets the user's own Mii data.</td> 302 </tr> 303 <tr> 304 <td width="100"> </td> 305 <th> 306<a href="../../../nn/friends/CTR/GetFriendKeyList.html"><CODE>GetFriendKeyList</CODE></a> 307 </th> 308<td>Gets a list of the friend keys registered in the friend list.</td> 309 </tr> 310 <tr> 311 <td width="100"> </td> 312 <th> 313<a href="../../../nn/friends/CTR/GetFriendPresence.html"><CODE>GetFriendPresence</CODE></a> 314 </th> 315<td>Gets a list of friend presence information.</td> 316 </tr> 317 <tr> 318 <td width="100"> </td> 319 <th> 320<a href="../../../nn/friends/CTR/GetFriendScreenName.html"><CODE>GetFriendScreenName</CODE></a> 321 </th> 322<td>Gets a list of friend screen names.</td> 323 </tr> 324 <tr> 325 <td width="100"> </td> 326 <th> 327<a href="../../../nn/friends/CTR/GetFriendMii.html"><CODE>GetFriendMii</CODE></a> 328 </th> 329<td>Gets a list of friends' Mii data.</td> 330 </tr> 331 <tr> 332 <td width="100"> </td> 333 <th> 334<a href="../../../nn/friends/CTR/GetFriendProfile.html"><CODE>GetFriendProfile</CODE></a> 335 </th> 336<td>Gets a list of friends' profile information.</td> 337 </tr> 338 <tr> 339 <td width="100"> </td> 340 <th> 341<a href="../../../nn/friends/CTR/GetFriendAttributeFlags.html"><CODE>GetFriendAttributeFlags</CODE></a> 342 </th> 343<td>Gets a list of friend relationships.</td> 344 </tr> 345 <tr> 346 <td width="100"> </td> 347 <th> 348<a href="../../../nn/friends/CTR/UnscrambleLocalFriendCode.html"><CODE>UnscrambleLocalFriendCode</CODE></a> 349 </th> 350<td>Decodes a friend's encoded local friend code.</td> 351 </tr> 352 <tr> 353 <td width="100"> </td> 354 <th> 355<a href="../../../nn/friends/CTR/UpdateGameModeDescription.html"><CODE>UpdateGameModeDescription</CODE></a> 356 </th> 357<td>Updates the game mode description string.</td> 358 </tr> 359 <tr> 360 <td width="100"> </td> 361 <th> 362<a href="../../../nn/friends/CTR/AttachToEventNotification.html"><CODE>AttachToEventNotification</CODE></a> 363 </th> 364<td>Specifies an event that notifies of changes in the local host's login state and friends' login states.</td> 365 </tr> 366 <tr> 367 <td width="100"> </td> 368 <th> 369<a href="../../../nn/friends/CTR/SetNotificationMask.html"><CODE>SetNotificationMask</CODE></a> 370 </th> 371<td>Specifies the type of notification received.</td> 372 </tr> 373 <tr> 374 <td width="100"> </td> 375 <th> 376<a href="../../../nn/friends/CTR/GetEventNotification.html"><CODE>GetEventNotification</CODE></a> 377 </th> 378<td>Gets the history of notifications of changes in the local user's online state and/or friends' online states.</td> 379 </tr> 380 <tr> 381 <td width="100"> </td> 382 <th> 383<a href="../../../nn/friends/CTR/GetLastResponseResult.html"><CODE>GetLastResponseResult</CODE></a> 384 </th> 385<td>Gets the result of the completed asynchronous operation.</td> 386 </tr> 387 <tr> 388 <td width="100"> </td> 389 <th> 390<a href="../../../nn/friends/CTR/ResultToErrorCode.html"><CODE>ResultToErrorCode</CODE></a> 391 </th> 392<td>Gets an error code from the result of a function in the friend presence library.</td> 393 </tr> </table> 394 </div> 395 </a> 396<h2>Revision History</h2> 397 <div class="section"> 398 <dl class="history"> 399 <dt>2011/03/14</dt> 400<dd>Corrected mistakes.<br /> 401 </dd> 402 <dt>2010/08/16</dt> 403<dd>Initial version.<br /> 404 </dd> 405 </dl> 406 </div> 407 <hr><p>CONFIDENTIAL</p></body> 408</html> 409