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