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><CODE>friends</CODE></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="../nnfriendsMiiInformation/Overview.html"><CODE>nnfriendsMiiInformation</CODE></a> 76 </th> 77 <td>Structure storing a user's display name and 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 host'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> 103 </table> 104 </div> 105 </a> <a name="macro" id="macro"> 106 <h2>Macros</h2> 107 <div class="section"> 108 <table class="members"> 109 <tr> 110 <td width="100"> </td> 111 <th> 112 <a href="../nn_friends/NN_FRIENDS_INVALID_PRINCIPAL_ID.html"><CODE>NN_FRIENDS_INVALID_PRINCIPAL_ID</CODE></a> 113 </th> 114 <td>Invalid principal ID.</td> 115 </tr> 116 <tr> 117 <td width="100"> </td> 118 <th> 119 <a href="../nn_friends/NN_FRIENDS_INVALID_LOCAL_FRIEND_CODE.html"><CODE>NN_FRIENDS_INVALID_LOCAL_FRIEND_CODE</CODE></a> 120 </th> 121 <td>Invalid local friend code.</td> 122 </tr> 123 <tr> 124 <td width="100"> </td> 125 <th> 126 <a href="../nn_friends/NN_FRIENDS_INVALID_FRIEND_CODE.html"><CODE>NN_FRIENDS_INVALID_FRIEND_CODE</CODE></a> 127 </th> 128 <td>Invalid friend code.</td> 129 </tr> </table> 130 </div> 131 </a> <a name="enum" id="enum"> 132 <h2>Enumerated Types</h2> 133 <div class="section"> 134 <table class="members"> 135 <tr> 136 <td width="100"> </td> 137 <th> 138 <a href="../nn_friends/nnfriendsPlatformCode.html"><CODE>nnfriendsPlatformCode</CODE></a> 139 </th> 140 <td>Enumerated type representing platform types.</td> 141 </tr> 142 <tr> 143 <td width="100"> </td> 144 <th> 145 <a href="../nn_friends/nnfriendsAttributeFlag.html"><CODE>nnfriendsAttributeFlag</CODE></a> 146 </th> 147 <td>Enumerated type representing friend relationships using attribute flags.</td> 148 </tr> 149 <tr> 150 <td width="100"> </td> 151 <th> 152 <a href="../nn_friends/nnfriendsNotificationType.html"><CODE>nnfriendsNotificationType</CODE></a> 153 </th> 154 <td>Enumerated type representing notification types.</td> 155 </tr> </table> 156 </div> 157 </a> <a name="typedef" id="typedef"> 158 <h2><CODE>typedef</CODE> Definitions</h2> 159 <div class="section"> 160 <table class="members"> 161 <tr> 162 <td width="100" /> 163 <th> 164 <a href="../nn_friends/nnfriendsPrincipalId.html"><CODE>nnfriendsPrincipalId</CODE></a> 165 </th> 166 <td>Represents a principal ID.</td> 167 </tr> 168 <tr> 169 <td width="100" /> 170 <th> 171 <a href="../nn_friends/nnfriendsLocalFriendCode.html"><CODE>nnfriendsLocalFriendCode</CODE></a> 172 </th> 173 <td>Represents a local friend code.</td> 174 </tr> </table> 175 </div> 176 </a> 177 <h2>Revision History</h2> 178 <div class="section"> 179 <dl class="history"> 180 <dt>2010/08/16</dt> 181 <dd>Initial version.<br /> 182 </dd> 183 </dl> 184 </div> 185 <hr><p>CONFIDENTIAL</p></body> 186</html>