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> </table>
180      </div>
181    </a> <a name="function" id="function">
182<h2>Functions</h2>
183      <div class="section">
184        <table class="members">
185          <tr>
186            <td width="100">  </td>
187            <th>
188<a href="../../../nn/friends/CTR/Initialize.html"><CODE>Initialize</CODE></a>
189            </th>
190<td>Initializes the Friend presence library and makes the presence features available for use.</td>
191          </tr>
192          <tr>
193            <td width="100">  </td>
194            <th>
195<a href="../../../nn/friends/CTR/Finalize.html"><CODE>Finalize</CODE></a>
196            </th>
197<td>Closes the friend presence library.</td>
198          </tr>
199          <tr>
200            <td width="100">  </td>
201            <th>
202<a href="../../../nn/friends/CTR/IsInitialized.html"><CODE>IsInitialized</CODE></a>
203            </th>
204<td>Checks whether the friend presence library is initialized.</td>
205          </tr>
206          <tr>
207            <td width="100">  </td>
208            <th>
209<a href="../../../nn/friends/CTR/HasLoggedIn.html"><CODE>HasLoggedIn</CODE></a>
210            </th>
211<td>Checks one's own login status.</td>
212          </tr>
213          <tr>
214            <td width="100">  </td>
215            <th>
216<a href="../../../nn/friends/CTR/Login.html"><CODE>Login</CODE></a>
217            </th>
218<td>Requests a login to the server.</td>
219          </tr>
220          <tr>
221            <td width="100">  </td>
222            <th>
223<a href="../../../nn/friends/CTR/Logout.html"><CODE>Logout</CODE></a>
224            </th>
225<td>Retracts a login request to a server.</td>
226          </tr>
227          <tr>
228            <td width="100">  </td>
229            <th>
230<a href="../../../nn/friends/CTR/GetMyPrincipalId.html"><CODE>GetMyPrincipalId</CODE></a>
231            </th>
232<td>Gets the local host's principal ID.</td>
233          </tr>
234          <tr>
235            <td width="100">  </td>
236            <th>
237<a href="../../../nn/friends/CTR/GetMyPreference.html"><CODE>GetMyPreference</CODE></a>
238            </th>
239<td>Gets the disclosure level of the local host's information.</td>
240          </tr>
241          <tr>
242            <td width="100">  </td>
243            <th>
244<a href="../../../nn/friends/CTR/GetMyProfile.html"><CODE>GetMyProfile</CODE></a>
245            </th>
246<td>Gets the local host's profile information.</td>
247          </tr>
248          <tr>
249            <td width="100">  </td>
250            <th>
251<a href="../../../nn/friends/CTR/GetMyPresence.html"><CODE>GetMyPresence</CODE></a>
252            </th>
253<td>Gets the local host's presence information.</td>
254          </tr>
255          <tr>
256            <td width="100">  </td>
257            <th>
258<a href="../../../nn/friends/CTR/GetMyScreenName.html">GetMyScreenName</a>
259            </th>
260<td>Obtains the user's own screen name.</td>
261          </tr>
262          <tr>
263            <td width="100">  </td>
264            <th>
265<a href="../../../nn/friends/CTR/GetMyMii.html"><CODE>GetMyMii</CODE></a>
266            </th>
267<td>Gets the one's own Mii data.</td>
268          </tr>
269          <tr>
270            <td width="100">  </td>
271            <th>
272<a href="../../../nn/friends/CTR/GetFriendKeyList.html"><CODE>GetFriendKeyList</CODE></a>
273            </th>
274<td>Gets a list of the friend keys registered in the friend list.</td>
275          </tr>
276          <tr>
277            <td width="100">  </td>
278            <th>
279<a href="../../../nn/friends/CTR/GetFriendPresence.html"><CODE>GetFriendPresence</CODE></a>
280            </th>
281<td>Gets a list of friend presence information.</td>
282          </tr>
283          <tr>
284            <td width="100">  </td>
285            <th>
286<a href="../../../nn/friends/CTR/GetFriendScreenName.html">GetFriendScreenName</a>
287            </th>
288<td>Gets a list of friend screen names.</td>
289          </tr>
290          <tr>
291            <td width="100">  </td>
292            <th>
293<a href="../../../nn/friends/CTR/GetFriendMii.html"><CODE>GetFriendMii</CODE></a>
294            </th>
295<td>Gets a list of friends' Mii data.</td>
296          </tr>
297          <tr>
298            <td width="100">  </td>
299            <th>
300<a href="../../../nn/friends/CTR/GetFriendProfile.html"><CODE>GetFriendProfile</CODE></a>
301            </th>
302<td>Gets a list of friends' profile information.</td>
303          </tr>
304          <tr>
305            <td width="100">  </td>
306            <th>
307<a href="../../../nn/friends/CTR/GetFriendAttributeFlags.html"><CODE>GetFriendAttributeFlags</CODE></a>
308            </th>
309<td>Gets a list of friend relationships.</td>
310          </tr>
311          <tr>
312            <td width="100">  </td>
313            <th>
314<a href="../../../nn/friends/CTR/UnscrambleLocalFriendCode.html">UnscrambleLocalFriendCode</a>
315            </th>
316<td>Decodes a friend's encoded local friend code.</td>
317          </tr>
318          <tr>
319            <td width="100">  </td>
320            <th>
321<a href="../../../nn/friends/CTR/UpdateGameModeDescription.html"><CODE>UpdateGameModeDescription</CODE></a>
322            </th>
323<td>Updates the game mode description string.</td>
324          </tr>
325          <tr>
326            <td width="100">  </td>
327            <th>
328<a href="../../../nn/friends/CTR/AttachToEventNotification.html"><CODE>AttachToEventNotification</CODE></a>
329            </th>
330<td>Specifies an event that notifies of changes in the local host's login state and friends' login states.</td>
331          </tr>
332          <tr>
333            <td width="100">  </td>
334            <th>
335<a href="../../../nn/friends/CTR/SetNotificationMask.html">SetNotificationMask</a>
336            </th>
337<td>Specifies the type of notification received.</td>
338          </tr>
339          <tr>
340            <td width="100">  </td>
341            <th>
342<a href="../../../nn/friends/CTR/GetEventNotification.html"><CODE>GetEventNotification</CODE></a>
343            </th>
344<td>Gets the history of notifications of changes in the local user's online state and/or friends' online states.</td>
345          </tr>
346          <tr>
347            <td width="100">  </td>
348            <th>
349<a href="../../../nn/friends/CTR/GetLastResponseResult.html"><CODE>GetLastResponseResult</CODE></a>
350            </th>
351<td>Gets the result of the completed asynchronous operation.</td>
352          </tr>
353          <tr>
354            <td width="100">  </td>
355            <th>
356<a href="../../../nn/friends/CTR/ResultToErrorCode.html"><CODE>ResultToErrorCode</CODE></a>
357            </th>
358<td>Gets an error code from a friend presence library function result.</td>
359          </tr> </table>
360      </div>
361    </a>
362<h2>Revision History</h2>
363    <div class="section">
364      <dl class="history">
365        <dt>2010/08/16</dt>
366<dd>Initial version.<br />
367        </dd>
368      </dl>
369    </div>
370  <hr><p>CONFIDENTIAL</p></body>
371</html>