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