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>friends</title> 49 </head> 50 <body> 51<h1>friends</h1> 52<h2>Description</h2> 53 <div class="section"> 54<p>Module that handles the FRIENDS library.</p><!-- write here --></div> 55 <a name="struct" id="struct"> 56<h2>Structures</h2> 57 <div class="section"> 58 <table class="members"> 59 <tr> 60 <th> 61<a href="../nnfriendsFriendKey/Overview.html"><CODE>nnfriendsFriendKey</CODE></a> 62 </th> 63<td>Structure for comprehensively handling users' principal IDs and local friend codes.</td> 64 </tr> 65 <tr> 66 <th> 67<a href="../nnfriendsProfile/Overview.html"><CODE>nnfriendsProfile</CODE></a> 68 </th> 69<td>Structure storing a user's profile information.</td> 70 </tr> 71 <tr> 72 <th> 73<a href="../nnfriendsMiiData/Overview.html">nnfriendsMiiData</a> 74 </th> 75<td>Structure storing Mii data.</td> 76 </tr> 77 <tr> 78 <th> 79<a href="../nnfriendsGameMode/Overview.html"><CODE>nnfriendsGameMode</CODE></a> 80 </th> 81<td>Structure storing information about the game the local host is currently playing. This information is required for friends to join in.</td> 82 </tr> 83 <tr> 84 <th> 85<a href="../nnfriendsMyPresence/Overview.html"><CODE>nnfriendsMyPresence</CODE></a> 86 </th> 87<td>Structure storing the local user's presence information.</td> 88 </tr> 89 <tr> 90 <th> 91<a href="../nnfriendsFriendPresence/Overview.html"><CODE>nnfriendsFriendPresence</CODE></a> 92 </th> 93<td>Structure storing friend presence information.</td> 94 </tr> 95 <tr> 96 <th> 97<a href="../nnfriendsEventNotification/Overview.html"><CODE>nnfriendsEventNotification</CODE></a> 98 </th> 99<td>Structure storing notifications of changes in the local host's online state and friends' online states.</td> 100 </tr> 101 <tr> 102 <th> 103<a href="../nnfriendsApproachContext/Overview.html">nnfriendsApproachContext</a> 104 </th> 105<td>This structure contains the current user's friend presence account information in order to allow other users to register them as a friend.</td> 106 </tr> </table> 107 </div> 108 </a> <a name="macro" id="macro"> 109<h2>Macros</h2> 110 <div class="section"> 111 <table class="members"> 112 <tr> 113 <td width="100"> </td> 114 <th> 115<a href="../nn_friends/NN_FRIENDS_INVALID_PRINCIPAL_ID.html"><CODE>NN_FRIENDS_INVALID_PRINCIPAL_ID</CODE></a> 116 </th> 117<td>Invalid principal ID.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122<a href="../nn_friends/NN_FRIENDS_INVALID_LOCAL_FRIEND_CODE.html"><CODE>NN_FRIENDS_INVALID_LOCAL_FRIEND_CODE</CODE></a> 123 </th> 124<td>Invalid local friend code.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129<a href="../nn_friends/NN_FRIENDS_SCREEN_NAME_SIZE.html">NN_FRIENDS_SCREEN_NAME_SIZE</a> 130 </th> 131<td>The number of elements in the buffer for the screen name. Includes the terminating character.</td> 132 </tr> 133 <tr> 134 <td width="100"> </td> 135 <th> 136<a href="../nn_friends/NN_FRIENDS_MODE_DESCRIPTION_SIZE.html">NN_FRIENDS_MODE_DESCRIPTION_SIZE</a> 137 </th> 138<td>The number of elements in the buffer for the game mode description string. Includes the terminating character.</td> 139 </tr> 140 <tr> 141 <td width="100"> </td> 142 <th> 143<a href="../nn_friends/NN_FRIENDS_MII_SIZE.html">NN_FRIENDS_MII_SIZE</a> 144 </th> 145<td>The size of the Mii character binary data.</td> 146 </tr> 147 <tr> 148 <td width="100"> </td> 149 <th> 150<a href="../nn_friends/NN_FRIENDS_FRIEND_LIST_SIZE.html">NN_FRIENDS_FRIEND_LIST_SIZE</a> 151 </th> 152<td>The size of the friend list. This is the maximum number of users that can be registered to the friend list.</td> 153 </tr> </table> 154 </div> 155 </a> <a name="enum" id="enum"> 156<h2>Enumerated Types</h2> 157 <div class="section"> 158 <table class="members"> 159 <tr> 160 <td width="100"> </td> 161 <th> 162<a href="../nn_friends/nnfriendsPlatformCode.html"><CODE>nnfriendsPlatformCode</CODE></a> 163 </th> 164<td>Enumerated type representing platform types.</td> 165 </tr> 166 <tr> 167 <td width="100"> </td> 168 <th> 169<a href="../nn_friends/nnfriendsAttributeFlag.html"><CODE>nnfriendsAttributeFlag</CODE></a> 170 </th> 171<td>Enumerated type representing friend relationships using attribute flags.</td> 172 </tr> 173 <tr> 174 <td width="100"> </td> 175 <th> 176<a href="../nn_friends/nnfriendsNotificationType.html"><CODE>nnfriendsNotificationType</CODE></a> 177 </th> 178<td>Enumerated type representing notification types.</td> 179 </tr> 180 <tr> 181 <td width="100"> </td> 182 <th> 183<a href="../nn_friends/nnfriendsNotificationMask.html">nnfriendsNotificationMask</a> 184 </th> 185<td>Enumerated type representing notification bitmasks.</td> 186 </tr> 187 <tr> 188 <td width="100"> </td> 189 <th> 190<a href="../nn_friends/nnfriendsJoinAvailability.html"><CODE>nnfriendsJoinAvailability</CODE></a> 191 </th> 192<td>Enumerated type representing conditions on allowing participation.</td> 193 </tr> 194 <tr> 195 <td width="100"> </td> 196 <th> 197<a href="../nn_friends/nnfriendsMatchmakeSystemType.html"><CODE>nnfriendsMatchmakeSystemType</CODE></a> 198 </th> 199<td>Enumerated type representing conditions on allowing participation.</td> 200 </tr> </table> 201 </div> 202 </a> <a name="typedef" id="typedef"> 203<h2><CODE>typedef</CODE> Definitions</h2> 204 <div class="section"> 205 <table class="members"> 206 <tr> 207 <td width="100" /> 208 <th> 209<a href="../nn_friends/nnfriendsPrincipalId.html"><CODE>nnfriendsPrincipalId</CODE></a> 210 </th> 211<td>Represents a principal ID.</td> 212 </tr> 213 <tr> 214 <td width="100" /> 215 <th> 216<a href="../nn_friends/nnfriendsLocalFriendCode.html"><CODE>nnfriendsLocalFriendCode</CODE></a> 217 </th> 218<td>Represents a local friend code.</td> 219 </tr> </table> 220 </div> 221 </a> 222<h2>Revision History</h2> 223 <div class="section"> 224 <dl class="history"> 225 <dt>2010/08/16</dt> 226<dd>Initial version.<br /> 227 </dd> 228 </dl> 229 </div> 230 <hr><p>CONFIDENTIAL</p></body> 231</html> 232