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::cfg::CTR</title>
51  </head>
52  <body>
53<h1><CODE>nn::cfg::CTR</CODE> Namespace</h1>
54<h2>Description</h2>
55    <div class="section">
56<p>Namespace for the System Settings API. <br />(This namespace can also be written without the <CODE>::CTR</CODE> portion.)</p><p>You must call <CODE>nn::cfg::Initialize</CODE> before any other function in the <a href="../../../nn/cfg/Overview.html"><CODE>nn::cfg</CODE></a> namespace that gets System Settings.</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="../../../nn/cfg/CTR/UserName/Overview.html"><CODE>nn::cfg::CTR::UserName</CODE></a>
64            </th>
65<td>Structure that represents the user name.</td>
66          </tr>
67          <tr>
68            <th>
69<a href="../../../nn/cfg/CTR/Birthday/Overview.html"><CODE>nn::cfg::CTR::Birthday</CODE></a>
70            </th>
71<td>Structure representing a birthday.</td>
72          </tr>
73          <tr>
74            <th>
75<a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html"><CODE>nn::cfg::CTR::SimpleAddress</CODE></a>
76            </th>
77<td>Structure that represents simple address information.</td>
78          </tr> </table>
79      </div>
80    </a> <a name="enum" id="enum">
81<h2>Enumerated Types</h2>
82      <div class="section">
83        <table class="members">
84          <tr>
85            <td width="100"> </td>
86            <th>
87<a href="../../../nn/cfg/CTR/CfgCountryCode.html"><CODE>CfgCountryCode</CODE></a>
88            </th>
89<td>Enumerated type that represents country and area codes.</td>
90          </tr>
91          <tr>
92            <td width="100"> </td>
93            <th>
94<a href="../../../nn/cfg/CTR/CfgLanguageCode.html"><CODE>CfgLanguageCode</CODE></a>
95            </th>
96<td>Enumerated type that represents language codes.</td>
97          </tr>
98          <tr>
99            <td width="100"> </td>
100            <th>
101<a href="../../../nn/cfg/CTR/CfgRegionCode.html"><CODE>CfgRegionCode</CODE></a>
102            </th>
103<td>Enumerated type that represents the region codes of system markets.</td>
104          </tr>
105          <tr>
106            <td width="100"> </td>
107            <th>
108<a href="../../../nn/cfg/CTR/CfgSoundOutputMode.html"><CODE>CfgSoundOutputMode</CODE></a>
109            </th>
110<td>Enumerated type that represents sound output modes.</td>
111          </tr> </table>
112      </div>
113    </a> <a name="constant" id="constant">
114<h2>Constants</h2>
115      <div class="section">
116        <table class="members">
117          <tr>
118            <td width="100"> </td>
119            <th>
120<span class="argument"><a href="../../../nn/cfg/CTR/CFG_PARENTAL_CONTROL_PIN_CODE_LENGTH.html">CFG_PARENTAL_CONTROL_PIN_CODE_LENGTH</a></span>
121            </th>
122<td>The string length of the Parental Controls PIN.</td>
123          </tr>
124          <tr>
125            <td width="100"> </td>
126            <th>
127<span class="argument"><a href="../../../nn/cfg/CTR/CFG_USER_NAME_LENGTH.html"><CODE>CFG_USER_NAME_LENGTH</CODE></a></span>
128            </th>
129<td>The maximum string length of the user name. (Including the terminator.)</td>
130          </tr>
131          <tr>
132            <td width="100"> </td>
133            <th>
134<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_COUNTRY_SHIFT.html"><CODE>CFG_SIMPLE_ADDRESS_ID_COUNTRY_SHIFT</CODE></a></span>
135            </th>
136<td>Indicates the country code storage location in a <CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID.</td>
137          </tr>
138          <tr>
139            <td width="100"> </td>
140            <th>
141<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_REGION_SHIFT.html"><CODE>CFG_SIMPLE_ADDRESS_ID_REGION_SHIFT</CODE></a></span>
142            </th>
143<td>Indicates the region code storage location in a <CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID.</td>
144          </tr>
145          <tr>
146            <td width="100"> </td>
147            <th>
148<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_COUNTRY_MASK.html"><CODE>CFG_SIMPLE_ADDRESS_ID_COUNTRY_MASK</CODE></a></span>
149            </th>
150<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID for a country code mask.</td>
151          </tr>
152          <tr>
153            <td width="100"> </td>
154            <th>
155<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_REGION_MASK.html"><CODE>CFG_SIMPLE_ADDRESS_ID_REGION_MASK</CODE></a></span>
156            </th>
157<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID for a region code mask.</td>
158          </tr>
159          <tr>
160            <td width="100"> </td>
161            <th>
162<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_RESERVED_MASK.html"><CODE>CFG_SIMPLE_ADDRESS_ID_RESERVED_MASK</CODE></a></span>
163            </th>
164<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID for a reserved region mask.</td>
165          </tr>
166          <tr>
167            <td width="100"> </td>
168            <th>
169<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_NOT_DEFINED.html"><CODE>CFG_SIMPLE_ADDRESS_ID_NOT_DEFINED</CODE></a></span>
170            </th>
171<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined ID.</td>
172          </tr>
173          <tr>
174            <td width="100"> </td>
175            <th>
176<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_COUNTRY_UNDEFINED.html"><CODE>CFG_SIMPLE_ADDRESS_ID_COUNTRY_UNDEFINED</CODE></a></span>
177            </th>
178<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined country code.</td>
179          </tr>
180          <tr>
181            <td width="100"> </td>
182            <th>
183<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_COUNTRY_UNDEFINED2.html"><CODE>CFG_SIMPLE_ADDRESS_ID_COUNTRY_UNDEFINED2</CODE></a></span>
184            </th>
185<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined country code.</td>
186          </tr>
187          <tr>
188            <td width="100"> </td>
189            <th>
190<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_REGION_UNDEFINED.html"><CODE>CFG_SIMPLE_ADDRESS_ID_REGION_UNDEFINED</CODE></a></span>
191            </th>
192<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined region code.</td>
193          </tr>
194          <tr>
195            <td width="100"> </td>
196            <th>
197<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_ID_REGION_UNDEFINED2.html"><CODE>CFG_SIMPLE_ADDRESS_ID_REGION_UNDEFINED2</CODE></a></span>
198            </th>
199<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined region code.</td>
200          </tr>
201          <tr>
202            <td width="100"> </td>
203            <th>
204<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_NUM_LANGUAGES.html"><CODE>CFG_SIMPLE_ADDRESS_NUM_LANGUAGES</CODE></a></span>
205            </th>
206<td>The number of languages for country/region names in simple address information.</td>
207          </tr>
208          <tr>
209            <td width="100"> </td>
210            <th>
211<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_NAME_LENGTH.html"><CODE>CFG_SIMPLE_ADDRESS_NAME_LENGTH</CODE></a></span>
212            </th>
213<td>The maximum string length for country/region names in simple address information.</td>
214          </tr> </table>
215      </div>
216    </a> <a name="function" id="function">
217<h2>Functions</h2>
218      <div class="section">
219        <table class="members">
220          <tr>
221            <td width="100">  </td>
222            <th>
223<a href="../../../nn/cfg/CTR/Initialize.html"><CODE>Initialize</CODE></a>
224            </th>
225<td>Initializes the System Settings library.</td>
226          </tr>
227          <tr>
228            <td width="100">  </td>
229            <th>
230<a href="../../../nn/cfg/CTR/Finalize.html"><CODE>Finalize</CODE></a>
231            </th>
232<td>Finalizes the System Settings library.</td>
233          </tr>
234          <tr>
235            <td width="100">  </td>
236            <th>
237<a href="../../../nn/cfg/CTR/GetUserName.html"><CODE>GetUserName</CODE></a>
238            </th>
239<td>Gets the user name.</td>
240          </tr>
241          <tr>
242            <td width="100">  </td>
243            <th>
244<a href="../../../nn/cfg/CTR/GetBirthday.html"><CODE>GetBirthday</CODE></a>
245            </th>
246<td>Gets the birthday.</td>
247          </tr>
248          <tr>
249            <td width="100">  </td>
250            <th>
251<a href="../../../nn/cfg/CTR/GetCountry.html"><CODE>GetCountry</CODE></a>
252            </th>
253<td>Gets the country and area code.</td>
254          </tr>
255          <tr>
256            <td width="100">  </td>
257            <th>
258<a href="../../../nn/cfg/CTR/GetCountryCodeA2.html"><CODE>GetCountryCodeA2</CODE></a>
259            </th>
260<td>Converts the country and area code to ISO 3166-1 alpha-2 format. This API is fast because it returns the value in memory.</td>
261          </tr>
262          <tr>
263            <td width="100">  </td>
264            <th>
265<a href="../../../nn/cfg/CTR/GetLanguage.html"><CODE>GetLanguage</CODE></a>
266            </th>
267<td>Gets the language code.</td>
268          </tr>
269          <tr>
270            <td width="100">  </td>
271            <th>
272<a href="../../../nn/cfg/CTR/GetLanguageCodeA2.html"><CODE>GetLanguageCodeA2</CODE></a>
273            </th>
274<td>Converts a language code to ISO 639-1 alpha-2 format. This API is fast because it returns the value in memory.</td>
275          </tr>
276          <tr>
277            <td width="100">  </td>
278            <th>
279<a href="../../../nn/cfg/CTR/GetSimpleAddress.html"><CODE>GetSimpleAddress</CODE></a>
280            </th>
281<td>Gets address information.</td>
282          </tr>
283          <tr>
284            <td width="100">  </td>
285            <th>
286<a href="../../../nn/cfg/CTR/GetRegion.html"><CODE>GetRegion</CODE></a>
287            </th>
288<td>Gets the region code of the system's market.</td>
289          </tr>
290          <tr>
291            <td width="100">  </td>
292            <th>
293<a href="../../../nn/cfg/CTR/GetRegionCodeA3.html"><CODE>GetRegionCodeA3</CODE></a>
294            </th>
295<td>Converts the region code of the system's market to the corresponding three-character string. This API is fast because it returns the value in memory.</td>
296          </tr>
297          <tr>
298            <td width="100">  </td>
299            <th>
300<a href="../../../nn/cfg/CTR/GetSoundOutputMode.html"><CODE>GetSoundOutputMode</CODE></a>
301            </th>
302<td>Gets the sound output mode.</td>
303          </tr>
304          <tr>
305            <td width="100">  </td>
306            <th>
307<a href="../../../nn/cfg/CTR/GetUserTimeOffset.html"><CODE>GetUserTimeOffset</CODE></a>
308            </th>
309<td>Gets RTC modification offset information.</td>
310          </tr>
311          <tr>
312            <td width="100">  </td>
313            <th>
314<a href="../../../nn/cfg/CTR/GetParentalControlPinCode.html">GetParentalControlPinCode</a>
315            </th>
316<td>Obtains the Parental Controls PIN.</td>
317          </tr>
318          <tr>
319            <td width="100">  </td>
320            <th>
321<a href="../../../nn/cfg/CTR/IsRestrictPhotoExchange.html">IsRestrictPhotoExchange</a>
322            </th>
323<td>Gets whether photo exchange is restricted by Parental Controls.</td>
324          </tr>
325          <tr>
326            <td width="100">  </td>
327            <th>
328<a href="../../../nn/cfg/CTR/IsRestrictAddFriend.html">IsRestrictAddFriend</a>
329            </th>
330<td>Gets whether adding friends is restricted by Parental Controls.</td>
331          </tr>
332          <tr>
333            <td width="100">  </td>
334            <th>
335<a href="../../../nn/cfg/CTR/IsRestrictP2pInternet.html"><CODE>IsRestrictP2pInternet</CODE></a>
336            </th>
337<td>Gets whether Internet communication with other users is restricted by Parental Controls.</td>
338          </tr>
339          <tr>
340            <td width="100">  </td>
341            <th>
342<a href="../../../nn/cfg/CTR/IsRestrictP2pCec.html"><CODE>IsRestrictP2pCec</CODE></a>
343            </th>
344<td>Gets whether StreetPass communication with other users is restricted by Parental Controls.</td>
345          </tr>
346          <tr>
347            <td width="100">  </td>
348            <th>
349<a href="../../../nn/cfg/CTR/IsAgreedEula.html">IsAgreedEula</a>
350            </th>
351<td>Obtains whether EULA consent was given.</td>
352          </tr>
353          <tr>
354            <td width="100">  </td>
355            <th>
356<a href="../../../nn/cfg/CTR/GetTransferableId.html">GetTransferableId</a>
357            </th>
358<td>Gets the system ID.</td>
359          </tr> </table>
360      </div>
361    </a>
362<h2>Revision History</h2>
363    <div class="section">
364      <dl class="history">
365        <dt>2010/05/27</dt>
366<dd>Initial version.<br />
367        </dd>
368      </dl>
369    </div>
370  <hr><p>CONFIDENTIAL</p></body>
371</html>