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::friends::CTR</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/friends/Overview.html">friends</a>::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>The namespace of the <a href="../../../nn/friends/CTR/Overview.html">CTR</a> friends library.<br /><br />(This namespace can also be written without the <CODE>::CTR</CODE> portion.)</p><!-- write here --></div> 57 <a name="enum" id="enum"> 58<h2>Enumerated Types</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <td width="100"> </td> 63 <th> 64<a href="../../../nn/friends/CTR/PlatformCode.html"><CODE>PlatformCode</CODE></a> 65 </th> 66<td>Enumerated type representing platform types.</td> 67 </tr> 68 <tr> 69 <td width="100"> </td> 70 <th> 71<a href="../../../nn/friends/CTR/AttributeFlag.html"><CODE>AttributeFlag</CODE></a> 72 </th> 73<td>Enumerated type representing friend relationships using attribute flags.</td> 74 </tr> 75 <tr> 76 <td width="100"> </td> 77 <th> 78<a href="../../../nn/friends/CTR/NotificationType.html"><CODE>NotificationType</CODE></a> 79 </th> 80<td>Enumerated type representing notification types.</td> 81 </tr> 82 <tr> 83 <td width="100"> </td> 84 <th> 85<a href="../../../nn/friends/CTR/NotificationMask.html"><CODE>NotificationMask</CODE></a> 86 </th> 87<td>Enumerated type representing notification bitmasks.</td> 88 </tr> 89 <tr> 90 <td width="100"> </td> 91 <th> 92<a href="../../../nn/friends/CTR/JoinAvailability.html"><CODE>JoinAvailability</CODE></a> 93 </th> 94<td>Enumerated type representing status of accepting participation.</td> 95 </tr> 96 <tr> 97 <td width="100"> </td> 98 <th> 99<a href="../../../nn/friends/CTR/MatchmakeSystemType.html"><CODE>MatchmakeSystemType</CODE></a> 100 </th> 101<td>Enumerated type indicating the conditions under which joining in is allowed.</td> 102 </tr> </table> 103 </div> 104 </a> <a name="typedef" id="typedef"> 105<h2><CODE>typedef</CODE> Definitions</h2> 106 <div class="section"> 107 <table class="members"> 108 <tr> 109 <td width="100" /> 110 <th> 111<a href="../../../nn/friends/CTR/PrincipalId.html"><CODE>PrincipalId</CODE></a> 112 </th> 113<td>Represents a principal ID.</td> 114 </tr> 115 <tr> 116 <td width="100" /> 117 <th> 118<a href="../../../nn/friends/CTR/LocalFriendCode.html"><CODE>LocalFriendCode</CODE></a> 119 </th> 120<td>Represents a local friend code.</td> 121 </tr> 122 <tr> 123 <td width="100" /> 124 <th> 125<a href="../../../nn/friends/CTR/FriendKey.html"><CODE>FriendKey</CODE></a> 126 </th> 127<td>Structure for comprehensively handling users' principal IDs and local friend codes.</td> 128 </tr> 129 <tr> 130 <td width="100" /> 131 <th> 132<a href="../../../nn/friends/CTR/Profile.html"><CODE>Profile</CODE></a> 133 </th> 134<td>Structure storing a user's profile information.</td> 135 </tr> 136 <tr> 137 <td width="100" /> 138 <th> 139<a href="../../../nn/friends/CTR/MiiData.html"><CODE>MiiData</CODE></a> 140 </th> 141<td>Structure storing Mii data.</td> 142 </tr> 143 <tr> 144 <td width="100" /> 145 <th> 146<a href="../../../nn/friends/CTR/GameMode.html"><CODE>GameMode</CODE></a> 147 </th> 148<td>Structure storing information about the game the local host is currently playing. This information is required for friends to join in.</td> 149 </tr> 150 <tr> 151 <td width="100" /> 152 <th> 153<a href="../../../nn/friends/CTR/MyPresence.html"><CODE>MyPresence</CODE></a> 154 </th> 155<td>Structure storing the local user's presence information.</td> 156 </tr> 157 <tr> 158 <td width="100" /> 159 <th> 160<a href="../../../nn/friends/CTR/FriendPresence.html"><CODE>FriendPresence</CODE></a> 161 </th> 162<td>Structure storing friend presence information.</td> 163 </tr> 164 <tr> 165 <td width="100" /> 166 <th> 167<a href="../../../nn/friends/CTR/EventNotification.html"><CODE>EventNotification</CODE></a> 168 </th> 169<td>Structure storing notifications of changes in the local host's online state and friends' online states.</td> 170 </tr> 171 <tr> 172 <td width="100" /> 173 <th> 174<a href="../../../nn/friends/CTR/ApproachContext.html"><CODE>ApproachContext</CODE></a> 175 </th> 176<td>This structure contains the current user's friend presence account information, in order to allow other users to register the user as a friend.</td> 177 </tr> </table> 178 </div> 179 </a> <a name="constant" id="constant"> 180<h2>Constants</h2> 181 <div class="section"> 182 <table class="members"> 183 <tr> 184 <td width="100"> 185<span class="static_style" title="static">S</span> 186 </td> 187 <th> 188<span class="argument"><a href="../../../nn/friends/CTR/INVALID_PRINCIPAL_ID.html"><CODE>INVALID_PRINCIPAL_ID</CODE></a></span> 189 </th> 190<td width="100">const <a href="../../../nn/friends/CTR/PrincipalId.html">PrincipalId</a></td> 191<td>Invalid principal ID.</td> 192 </tr> 193 <tr> 194 <td width="100"> 195<span class="static_style" title="static">S</span> 196 </td> 197 <th> 198<span class="argument"><a href="../../../nn/friends/CTR/INVALID_LOCAL_FRIEND_CODE.html"><CODE>INVALID_LOCAL_FRIEND_CODE</CODE></a></span> 199 </th> 200<td width="100">const <a href="../../../nn/friends/CTR/LocalFriendCode.html">LocalFriendCode</a></td> 201<td>Invalid local friend code.</td> 202 </tr> 203 <tr> 204 <td width="100"> 205<span class="static_style" title="static">S</span> 206 </td> 207 <th> 208<span class="argument"><a href="../../../nn/friends/CTR/SCREEN_NAME_SIZE.html"><CODE>SCREEN_NAME_SIZE</CODE></a></span> 209 </th> 210<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 211<td>The number of elements in the buffer for the screen name. Includes the terminating character.</td> 212 </tr> 213 <tr> 214 <td width="100"> 215<span class="static_style" title="static">S</span> 216 </td> 217 <th> 218<span class="argument"><a href="../../../nn/friends/CTR/MODE_DESCRIPTION_SIZE.html"><CODE>MODE_DESCRIPTION_SIZE</CODE></a></span> 219 </th> 220<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 221<td>The number of elements in the buffer for the game mode description string. Includes the terminating character.</td> 222 </tr> 223 <tr> 224 <td width="100"> 225<span class="static_style" title="static">S</span> 226 </td> 227 <th> 228<span class="argument"><a href="../../../nn/friends/CTR/MII_SIZE.html"><CODE>MII_SIZE</CODE></a></span> 229 </th> 230<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 231<td>The size of the Mii character binary data.</td> 232 </tr> 233 <tr> 234 <td width="100"> 235<span class="static_style" title="static">S</span> 236 </td> 237 <th> 238<span class="argument"><a href="../../../nn/friends/CTR/FRIEND_LIST_SIZE.html"><CODE>FRIEND_LIST_SIZE</CODE></a></span> 239 </th> 240<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 241<td>The size of the friend list. This is the maximum number of users that can be registered to the friend list.</td> 242 </tr> </table> 243 </div> 244 </a> <a name="function" id="function"> 245<h2>Functions</h2> 246 <div class="section"> 247 <table class="members"> 248 <tr> 249 <td width="100"> </td> 250 <th> 251<a href="../../../nn/friends/CTR/Initialize.html"><CODE>Initialize</CODE></a> 252 </th> 253<td>Initializes the friend presence library and makes the presence features available for use.</td> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258<a href="../../../nn/friends/CTR/Finalize.html"><CODE>Finalize</CODE></a> 259 </th> 260<td>Finalizes the friend presence library.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265<a href="../../../nn/friends/CTR/IsInitialized.html"><CODE>IsInitialized</CODE></a> 266 </th> 267<td>Checks whether the friend presence library is initialized.</td> 268 </tr> 269 <tr> 270 <td width="100"> </td> 271 <th> 272<a href="../../../nn/friends/CTR/HasLoggedIn.html"><CODE>HasLoggedIn</CODE></a> 273 </th> 274<td>Checks the login status of the local application.</td> 275 </tr> 276 <tr> 277 <td width="100"> </td> 278 <th> 279<a href="../../../nn/friends/CTR/Login.html"><CODE>Login</CODE></a> 280 </th> 281<td>Requests a login to the server.</td> 282 </tr> 283 <tr> 284 <td width="100"> </td> 285 <th> 286<a href="../../../nn/friends/CTR/Logout.html"><CODE>Logout</CODE></a> 287 </th> 288<td>Retracts a login request to a server.</td> 289 </tr> 290 <tr> 291 <td width="100"> </td> 292 <th> 293<a href="../../../nn/friends/CTR/GetMyPrincipalId.html"><CODE>GetMyPrincipalId</CODE></a> 294 </th> 295<td>Gets the local host's principal ID.</td> 296 </tr> 297 <tr> 298 <td width="100"> </td> 299 <th> 300<a href="../../../nn/friends/CTR/IsMyPreferenceValid.html"><CODE>IsMyPreferenceValid</CODE></a> 301 </th> 302<td>Returns a value indicating whether the user has already configured how much personal information is disclosed.</td> 303 </tr> 304 <tr> 305 <td width="100"> </td> 306 <th> 307<a href="../../../nn/friends/CTR/GetMyPreference.html"><CODE>GetMyPreference</CODE></a> 308 </th> 309<td>Gets values that indicate how much personal information is disclosed.</td> 310 </tr> 311 <tr> 312 <td width="100"> </td> 313 <th> 314<a href="../../../nn/friends/CTR/GetMyProfile.html"><CODE>GetMyProfile</CODE></a> 315 </th> 316<td>Gets the local host's profile information.</td> 317 </tr> 318 <tr> 319 <td width="100"> </td> 320 <th> 321<a href="../../../nn/friends/CTR/GetMyPresence.html"><CODE>GetMyPresence</CODE></a> 322 </th> 323<td>Gets the local host's presence information.</td> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328<a href="../../../nn/friends/CTR/GetMyScreenName.html"><CODE>GetMyScreenName</CODE></a> 329 </th> 330<td>Obtains the user's own screen name.</td> 331 </tr> 332 <tr> 333 <td width="100"> </td> 334 <th> 335<a href="../../../nn/friends/CTR/GetMyMii.html"><CODE>GetMyMii</CODE></a> 336 </th> 337<td>Gets Personal Mii data.</td> 338 </tr> 339 <tr> 340 <td width="100"> </td> 341 <th> 342<a href="../../../nn/friends/CTR/GetFriendKeyList.html"><CODE>GetFriendKeyList</CODE></a> 343 </th> 344<td>Gets a list of the friend keys registered in the friend list.</td> 345 </tr> 346 <tr> 347 <td width="100"> </td> 348 <th> 349<a href="../../../nn/friends/CTR/GetFriendPresence.html"><CODE>GetFriendPresence</CODE></a> 350 </th> 351<td>Gets a list of friend presence information.</td> 352 </tr> 353 <tr> 354 <td width="100"> </td> 355 <th> 356<a href="../../../nn/friends/CTR/GetFriendScreenName.html"><CODE>GetFriendScreenName</CODE></a> 357 </th> 358<td>Gets a list of friend screen names.</td> 359 </tr> 360 <tr> 361 <td width="100"> </td> 362 <th> 363<a href="../../../nn/friends/CTR/GetFriendMii.html"><CODE>GetFriendMii</CODE></a> 364 </th> 365<td>Gets a list of friends' Mii data.</td> 366 </tr> 367 <tr> 368 <td width="100"> </td> 369 <th> 370<a href="../../../nn/friends/CTR/GetFriendProfile.html"><CODE>GetFriendProfile</CODE></a> 371 </th> 372<td>Gets a list of friends' profile information.</td> 373 </tr> 374 <tr> 375 <td width="100"> </td> 376 <th> 377<a href="../../../nn/friends/CTR/GetFriendAttributeFlags.html"><CODE>GetFriendAttributeFlags</CODE></a> 378 </th> 379<td>Gets a list of friend relationships.</td> 380 </tr> 381 <tr> 382 <td width="100"> </td> 383 <th> 384<a href="../../../nn/friends/CTR/UnscrambleLocalFriendCode.html"><CODE>UnscrambleLocalFriendCode</CODE></a> 385 </th> 386<td>Decodes a friend's encoded local friend code.</td> 387 </tr> 388 <tr> 389 <td width="100"> </td> 390 <th> 391<a href="../../../nn/friends/CTR/UpdateGameModeDescription.html"><CODE>UpdateGameModeDescription</CODE></a> 392 </th> 393<td>Updates the game mode description string.</td> 394 </tr> 395 <tr> 396 <td width="100"> </td> 397 <th> 398<a href="../../../nn/friends/CTR/UpdateGameMode.html"><CODE>UpdateGameMode</CODE></a> 399 </th> 400<td>Updates the game mode.</td> 401 </tr> 402 <tr> 403 <td width="100"> </td> 404 <th> 405<a href="../../../nn/friends/CTR/AttachToEventNotification.html"><CODE>AttachToEventNotification</CODE></a> 406 </th> 407<td>Specifies an event that notifies of changes in the local host's login state and friends' login states.</td> 408 </tr> 409 <tr> 410 <td width="100"> </td> 411 <th> 412<a href="../../../nn/friends/CTR/SetNotificationMask.html"><CODE>SetNotificationMask</CODE></a> 413 </th> 414<td>Specifies the type of notification received.</td> 415 </tr> 416 <tr> 417 <td width="100"> </td> 418 <th> 419<a href="../../../nn/friends/CTR/GetEventNotification.html"><CODE>GetEventNotification</CODE></a> 420 </th> 421<td>Gets the history of notifications of changes in the local user's online state and/or friends' online states.</td> 422 </tr> 423 <tr> 424 <td width="100"> </td> 425 <th> 426<a href="../../../nn/friends/CTR/GetLastResponseResult.html"><CODE>GetLastResponseResult</CODE></a> 427 </th> 428<td>Gets the result of the completed asynchronous operation.</td> 429 </tr> 430 <tr> 431 <td width="100"> </td> 432 <th> 433<a href="../../../nn/friends/CTR/ResultToErrorCode.html"><CODE>ResultToErrorCode</CODE></a> 434 </th> 435<td>Gets an error code from a friend presence library function result.</td> 436 </tr> 437 <tr> 438 <td width="100"> </td> 439 <th> 440<a href="../../../nn/friends/CTR/IsFromFriendList.html"><CODE>IsFromFriendList</CODE></a> 441 </th> 442<td>Determines whether the application was started by pressing the "Join game being played" on the friend list.</td> 443 </tr> 444 <tr> 445 <td width="100"> </td> 446 <th> 447<a href="../../../nn/friends/CTR/GetMyApproachContext.html"><CODE>GetMyApproachContext</CODE></a> 448 </th> 449<td>Gets the local account information as a pack, required to be registered as other user's friend.</td> 450 </tr> 451 <tr> 452 <td width="100"> </td> 453 <th> 454<a href="../../../nn/friends/CTR/AddFriendWithApproach.html"><CODE>AddFriendWithApproach</CODE></a> 455 </th> 456<td>Adds a user that includes an approach context to the friend list.</td> 457 </tr> 458 <tr> 459 <td width="100"> </td> 460 <th> 461<a href="../../../nn/friends/CTR/GetApproachContextScreenName.html"><CODE>GetApproachContextScreenName</CODE></a> 462 </th> 463<td>Gets the user's display name included in the approach context.</td> 464 </tr> 465 <tr> 466 <td width="100"> </td> 467 <th> 468<a href="../../../nn/friends/CTR/GetApproachContextMii.html"><CODE>GetApproachContextMii</CODE></a> 469 </th> 470<td>Gets the user's Mii character included in the approach context.</td> 471 </tr> </table> 472 </div> 473 </a> 474<h2>Revision History</h2> 475 <div class="section"> 476 <dl class="history"> 477 <dt>2011/12/16</dt> 478<dd>Added <CODE>ApproachContext</CODE> structure.<br />Added <CODE>GetMyApproachContext</CODE> function.<br />Added <CODE>AddFriendWithApproach</CODE> function.<br />Added <CODE>GetApproachContextScreenName</CODE> function.<br />Added <CODE>GetApproachContextMii</CODE> function.<br /> 479 </dd> 480 <dt>2011/09/07</dt> 481<dd>Added the <CODE>IsMyPreferenceValid</CODE> function.<br /> 482 </dd> 483 <dt>2011/08/30</dt> 484<dd>Added the <CODE>UpdateGameMode</CODE> function.<br />Added the <CODE>IsFromFriendList</CODE> function.<br /> 485 </dd> 486 <dt>2011/03/14</dt> 487<dd>Corrected typos.<br /> 488 </dd> 489 <dt>2010/08/16</dt> 490<dd>Initial version.<br /> 491 </dd> 492 </dl> 493 </div> 494 <hr><p>CONFIDENTIAL</p></body> 495</html>