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