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><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/friends/Overview.html">friends</a>::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">NotificationMask</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">MiiData</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 width="100">const <a href="../../../nn/friends/CTR/PrincipalId.html">PrincipalId</a></td> 168<td>Invalid principal ID.</td> 169 </tr> 170 <tr> 171 <td width="100"> 172<span class="static_style" title="static">S</span> 173 </td> 174 <th> 175<span class="argument"><a href="../../../nn/friends/CTR/INVALID_LOCAL_FRIEND_CODE.html"><CODE>INVALID_LOCAL_FRIEND_CODE</CODE></a></span> 176 </th> 177<td width="100">const <a href="../../../nn/friends/CTR/LocalFriendCode.html">LocalFriendCode</a></td> 178<td>Invalid local friend code.</td> 179 </tr> 180 <tr> 181 <td width="100"> 182<span class="static_style" title="static">S</span> 183 </td> 184 <th> 185<span class="argument"><a href="../../../nn/friends/CTR/SCREEN_NAME_SIZE.html">SCREEN_NAME_SIZE</a></span> 186 </th> 187<td width="100"><CODE>const u32</CODE></td> 188<td>The number of elements in the buffer for the screen name. Includes the terminating character.</td> 189 </tr> 190 <tr> 191 <td width="100"> 192<span class="static_style" title="static">S</span> 193 </td> 194 <th> 195<span class="argument"><a href="../../../nn/friends/CTR/MODE_DESCRIPTION_SIZE.html">MODE_DESCRIPTION_SIZE</a></span> 196 </th> 197<td width="100"><CODE>const u32</CODE></td> 198<td>The number of elements in the buffer for the game mode description string. Includes the terminating character.</td> 199 </tr> 200 <tr> 201 <td width="100"> 202<span class="static_style" title="static">S</span> 203 </td> 204 <th> 205<span class="argument"><a href="../../../nn/friends/CTR/MII_SIZE.html">MII_SIZE</a></span> 206 </th> 207<td width="100"><CODE>const u32</CODE></td> 208<td>The size of the Mii character binary data.</td> 209 </tr> 210 <tr> 211 <td width="100"> 212<span class="static_style" title="static">S</span> 213 </td> 214 <th> 215<span class="argument"><a href="../../../nn/friends/CTR/FRIEND_LIST_SIZE.html">FRIEND_LIST_SIZE</a></span> 216 </th> 217<td width="100"><CODE>const u32</CODE></td> 218<td>The size of the friend list. This is the maximum number of users that can be registered to the friend list.</td> 219 </tr> </table> 220 </div> 221 </a> <a name="function" id="function"> 222<h2>Functions</h2> 223 <div class="section"> 224 <table class="members"> 225 <tr> 226 <td width="100"> </td> 227 <th> 228<a href="../../../nn/friends/CTR/Initialize.html"><CODE>Initialize</CODE></a> 229 </th> 230<td>Initializes the friend presence library and makes the presence features available for use.</td> 231 </tr> 232 <tr> 233 <td width="100"> </td> 234 <th> 235<a href="../../../nn/friends/CTR/Finalize.html"><CODE>Finalize</CODE></a> 236 </th> 237<td>Finalizes the friend presence library.</td> 238 </tr> 239 <tr> 240 <td width="100"> </td> 241 <th> 242<a href="../../../nn/friends/CTR/IsInitialized.html"><CODE>IsInitialized</CODE></a> 243 </th> 244<td>Checks whether the friend presence library is initialized.</td> 245 </tr> 246 <tr> 247 <td width="100"> </td> 248 <th> 249<a href="../../../nn/friends/CTR/HasLoggedIn.html"><CODE>HasLoggedIn</CODE></a> 250 </th> 251<td>Checks the login status of the local application.</td> 252 </tr> 253 <tr> 254 <td width="100"> </td> 255 <th> 256<a href="../../../nn/friends/CTR/Login.html"><CODE>Login</CODE></a> 257 </th> 258<td>Requests a login to the server.</td> 259 </tr> 260 <tr> 261 <td width="100"> </td> 262 <th> 263<a href="../../../nn/friends/CTR/Logout.html"><CODE>Logout</CODE></a> 264 </th> 265<td>Retracts a login request to a server.</td> 266 </tr> 267 <tr> 268 <td width="100"> </td> 269 <th> 270<a href="../../../nn/friends/CTR/GetMyPrincipalId.html"><CODE>GetMyPrincipalId</CODE></a> 271 </th> 272<td>Gets the local host's principal ID.</td> 273 </tr> 274 <tr> 275 <td width="100"> </td> 276 <th> 277<a href="../../../nn/friends/CTR/GetMyPreference.html"><CODE>GetMyPreference</CODE></a> 278 </th> 279<td>Gets the disclosure level of the local host's information.</td> 280 </tr> 281 <tr> 282 <td width="100"> </td> 283 <th> 284<a href="../../../nn/friends/CTR/GetMyProfile.html"><CODE>GetMyProfile</CODE></a> 285 </th> 286<td>Gets the local host's profile information.</td> 287 </tr> 288 <tr> 289 <td width="100"> </td> 290 <th> 291<a href="../../../nn/friends/CTR/GetMyPresence.html"><CODE>GetMyPresence</CODE></a> 292 </th> 293<td>Gets the local host's presence information.</td> 294 </tr> 295 <tr> 296 <td width="100"> </td> 297 <th> 298<a href="../../../nn/friends/CTR/GetMyScreenName.html">GetMyScreenName</a> 299 </th> 300<td>Obtains the user's own screen name.</td> 301 </tr> 302 <tr> 303 <td width="100"> </td> 304 <th> 305<a href="../../../nn/friends/CTR/GetMyMii.html"><CODE>GetMyMii</CODE></a> 306 </th> 307<td>Gets the user's own Mii data.</td> 308 </tr> 309 <tr> 310 <td width="100"> </td> 311 <th> 312<a href="../../../nn/friends/CTR/GetFriendKeyList.html"><CODE>GetFriendKeyList</CODE></a> 313 </th> 314<td>Gets a list of the friend keys registered in the friend list.</td> 315 </tr> 316 <tr> 317 <td width="100"> </td> 318 <th> 319<a href="../../../nn/friends/CTR/GetFriendPresence.html"><CODE>GetFriendPresence</CODE></a> 320 </th> 321<td>Gets a list of friend presence information.</td> 322 </tr> 323 <tr> 324 <td width="100"> </td> 325 <th> 326<a href="../../../nn/friends/CTR/GetFriendScreenName.html">GetFriendScreenName</a> 327 </th> 328<td>Gets a list of friend screen names.</td> 329 </tr> 330 <tr> 331 <td width="100"> </td> 332 <th> 333<a href="../../../nn/friends/CTR/GetFriendMii.html"><CODE>GetFriendMii</CODE></a> 334 </th> 335<td>Gets a list of friends' Mii data.</td> 336 </tr> 337 <tr> 338 <td width="100"> </td> 339 <th> 340<a href="../../../nn/friends/CTR/GetFriendProfile.html"><CODE>GetFriendProfile</CODE></a> 341 </th> 342<td>Gets a list of friends' profile information.</td> 343 </tr> 344 <tr> 345 <td width="100"> </td> 346 <th> 347<a href="../../../nn/friends/CTR/GetFriendAttributeFlags.html"><CODE>GetFriendAttributeFlags</CODE></a> 348 </th> 349<td>Gets a list of friend relationships.</td> 350 </tr> 351 <tr> 352 <td width="100"> </td> 353 <th> 354<a href="../../../nn/friends/CTR/UnscrambleLocalFriendCode.html">UnscrambleLocalFriendCode</a> 355 </th> 356<td>Decodes a friend's encoded local friend code.</td> 357 </tr> 358 <tr> 359 <td width="100"> </td> 360 <th> 361<a href="../../../nn/friends/CTR/UpdateGameModeDescription.html"><CODE>UpdateGameModeDescription</CODE></a> 362 </th> 363<td>Updates the game mode description string.</td> 364 </tr> 365 <tr> 366 <td width="100"> </td> 367 <th> 368<a href="../../../nn/friends/CTR/AttachToEventNotification.html"><CODE>AttachToEventNotification</CODE></a> 369 </th> 370<td>Specifies an event that notifies of changes in the local host's login state and friends' login states.</td> 371 </tr> 372 <tr> 373 <td width="100"> </td> 374 <th> 375<a href="../../../nn/friends/CTR/SetNotificationMask.html">SetNotificationMask</a> 376 </th> 377<td>Specifies the type of notification received.</td> 378 </tr> 379 <tr> 380 <td width="100"> </td> 381 <th> 382<a href="../../../nn/friends/CTR/GetEventNotification.html"><CODE>GetEventNotification</CODE></a> 383 </th> 384<td>Gets the history of notifications of changes in the local user's online state and/or friends' online states.</td> 385 </tr> 386 <tr> 387 <td width="100"> </td> 388 <th> 389<a href="../../../nn/friends/CTR/GetLastResponseResult.html"><CODE>GetLastResponseResult</CODE></a> 390 </th> 391<td>Gets the result of the completed asynchronous operation.</td> 392 </tr> 393 <tr> 394 <td width="100"> </td> 395 <th> 396<a href="../../../nn/friends/CTR/ResultToErrorCode.html"><CODE>ResultToErrorCode</CODE></a> 397 </th> 398<td>Gets an error code from a friend presence library function result.</td> 399 </tr> </table> 400 </div> 401 </a> 402<h2>Revision History</h2> 403 <div class="section"> 404 <dl class="history"> 405 <dt>2011/03/14</dt> 406<dd>Corrected typos.<br /> 407 </dd> 408 <dt>2010/08/16</dt> 409<dd>Initial version.<br /> 410 </dd> 411 </dl> 412 </div> 413 <hr><p>CONFIDENTIAL</p></body> 414</html> 415