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> </table>
101      </div>
102    </a> <a name="macro" id="macro">
103<h2>Macros</h2>
104      <div class="section">
105        <table class="members">
106          <tr>
107            <td width="100"> </td>
108            <th>
109<a href="../nn_friends/NN_FRIENDS_INVALID_PRINCIPAL_ID.html"><CODE>NN_FRIENDS_INVALID_PRINCIPAL_ID</CODE></a>
110            </th>
111<td>Invalid principal ID.</td>
112          </tr>
113          <tr>
114            <td width="100"> </td>
115            <th>
116<a href="../nn_friends/NN_FRIENDS_INVALID_LOCAL_FRIEND_CODE.html"><CODE>NN_FRIENDS_INVALID_LOCAL_FRIEND_CODE</CODE></a>
117            </th>
118<td>Invalid local friend code.</td>
119          </tr>
120          <tr>
121            <td width="100"> </td>
122            <th>
123<a href="../nn_friends/NN_FRIENDS_SCREEN_NAME_SIZE.html">NN_FRIENDS_SCREEN_NAME_SIZE</a>
124            </th>
125<td>The number of elements in the buffer for the screen name. Includes the terminating character.</td>
126          </tr>
127          <tr>
128            <td width="100"> </td>
129            <th>
130<a href="../nn_friends/NN_FRIENDS_MODE_DESCRIPTION_SIZE.html">NN_FRIENDS_MODE_DESCRIPTION_SIZE</a>
131            </th>
132<td>The number of elements in the buffer for the game mode description string. Includes the terminating character.</td>
133          </tr>
134          <tr>
135            <td width="100"> </td>
136            <th>
137<a href="../nn_friends/NN_FRIENDS_MII_SIZE.html">NN_FRIENDS_MII_SIZE</a>
138            </th>
139<td>The size of the Mii character binary data.</td>
140          </tr>
141          <tr>
142            <td width="100"> </td>
143            <th>
144<a href="../nn_friends/NN_FRIENDS_FRIEND_LIST_SIZE.html">NN_FRIENDS_FRIEND_LIST_SIZE</a>
145            </th>
146<td>The size of the friend list. This is the maximum number of users that can be registered to the friend list.</td>
147          </tr> </table>
148      </div>
149    </a> <a name="enum" id="enum">
150<h2>Enumerated Types</h2>
151      <div class="section">
152        <table class="members">
153          <tr>
154            <td width="100"> </td>
155            <th>
156<a href="../nn_friends/nnfriendsPlatformCode.html"><CODE>nnfriendsPlatformCode</CODE></a>
157            </th>
158<td>Enumerated type representing platform types.</td>
159          </tr>
160          <tr>
161            <td width="100"> </td>
162            <th>
163<a href="../nn_friends/nnfriendsAttributeFlag.html"><CODE>nnfriendsAttributeFlag</CODE></a>
164            </th>
165<td>Enumerated type representing friend relationships using attribute flags.</td>
166          </tr>
167          <tr>
168            <td width="100"> </td>
169            <th>
170<a href="../nn_friends/nnfriendsNotificationType.html"><CODE>nnfriendsNotificationType</CODE></a>
171            </th>
172<td>Enumerated type representing notification types.</td>
173          </tr>
174          <tr>
175            <td width="100"> </td>
176            <th>
177<a href="../nn_friends/nnfriendsNotificationMask.html">nnfriendsNotificationMask</a>
178            </th>
179<td>Enumerated type representing notification bitmasks.</td>
180          </tr> </table>
181      </div>
182    </a> <a name="typedef" id="typedef">
183<h2><CODE>typedef</CODE> Definitions</h2>
184      <div class="section">
185        <table class="members">
186          <tr>
187            <td width="100" />
188            <th>
189<a href="../nn_friends/nnfriendsPrincipalId.html"><CODE>nnfriendsPrincipalId</CODE></a>
190            </th>
191<td>Represents a principal ID.</td>
192          </tr>
193          <tr>
194            <td width="100" />
195            <th>
196<a href="../nn_friends/nnfriendsLocalFriendCode.html"><CODE>nnfriendsLocalFriendCode</CODE></a>
197            </th>
198<td>Represents a local friend code.</td>
199          </tr> </table>
200      </div>
201    </a>
202<h2>Revision History</h2>
203    <div class="section">
204      <dl class="history">
205        <dt>2010/08/16</dt>
206<dd>Initial version.<br />
207        </dd>
208      </dl>
209    </div>
210  <hr><p>CONFIDENTIAL</p></body>
211</html>
212