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><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/cfg/Overview.html">cfg</a>::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><a href="../../../nn/cfg/CTR/Initialize.html">nn::cfg::CTR::Initialize</a></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="class" id="class"> 58<h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62<th class="category" colspan="2"><CODE>Result</CODE></th> 63 </tr> 64 <tr> 65 <th> 66<a href="../../../nn/cfg/CTR/ResultOutOfMemory/Overview.html">nn::cfg::CTR::ResultOutOfMemory</a> 67 </th> 68<td>Insufficient memory.</td> 69 </tr> 70 <tr> 71 <th> 72<a href="../../../nn/cfg/CTR/ResultNotFound/Overview.html">nn::cfg::CTR::ResultNotFound</a> 73 </th> 74<td>Target cannot be found.</td> 75 </tr> 76 <tr> 77 <th> 78<a href="../../../nn/cfg/CTR/ResultMountContentFailed/Overview.html">nn::cfg::CTR::ResultMountContentFailed</a> 79 </th> 80<td>Failed to mount content.</td> 81 </tr> </table> 82 </div> 83 </a> <a name="struct" id="struct"> 84<h2>Structures</h2> 85 <div class="section"> 86 <table class="members"> 87 <tr> 88 <th> 89<a href="../../../nn/cfg/CTR/UserName/Overview.html"><CODE>nn::cfg::CTR::UserName</CODE></a> 90 </th> 91<td>Structure that represents the user name.</td> 92 </tr> 93 <tr> 94 <th> 95<a href="../../../nn/cfg/CTR/Birthday/Overview.html"><CODE>nn::cfg::CTR::Birthday</CODE></a> 96 </th> 97<td>Structure that represents a birthday.</td> 98 </tr> 99 <tr> 100 <th> 101<a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html"><CODE>nn::cfg::CTR::SimpleAddress</CODE></a> 102 </th> 103<td>Structure that represents the user's simple address information configured in the System Settings.</td> 104 </tr> 105 <tr> 106 <th> 107<a href="../../../nn/cfg/CTR/SimpleAddressId/Overview.html"><CODE>nn::cfg::CTR::SimpleAddressId</CODE></a> 108 </th> 109<td>Structure that represents simple address information IDs.</td> 110 </tr> </table> 111 </div> 112 </a> <a name="enum" id="enum"> 113<h2>Enumerated Types</h2> 114 <div class="section"> 115 <table class="members"> 116 <tr> 117 <td width="100"> </td> 118 <th> 119<a href="../../../nn/cfg/CTR/CfgCoppacsRestriction.html"><CODE>CfgCoppacsRestriction</CODE></a> 120 </th> 121<td>Enumerated type representing COPPACS restrictions.</td> 122 </tr> 123 <tr> 124 <td width="100"> </td> 125 <th> 126<a href="../../../nn/cfg/CTR/CfgCountryCode.html"><CODE>CfgCountryCode</CODE></a> 127 </th> 128<td>Enumerated type that represents country and area codes.</td> 129 </tr> 130 <tr> 131 <td width="100"> </td> 132 <th> 133<a href="../../../nn/cfg/CTR/CfgLanguageCode.html"><CODE>CfgLanguageCode</CODE></a> 134 </th> 135<td>Enumerated type that represents language codes.</td> 136 </tr> 137 <tr> 138 <td width="100"> </td> 139 <th> 140<a href="../../../nn/cfg/CTR/CfgRegionCode.html"><CODE>CfgRegionCode</CODE></a> 141 </th> 142<td>Enumerated type that represents the region codes of system markets.</td> 143 </tr> 144 <tr> 145 <td width="100"> </td> 146 <th> 147<a href="../../../nn/cfg/CTR/CfgSoundOutputMode.html"><CODE>CfgSoundOutputMode</CODE></a> 148 </th> 149<td>Enumerated type that represents sound output modes.</td> 150 </tr> </table> 151 </div> 152 </a> <a name="constant" id="constant"> 153<h2>Constants</h2> 154 <div class="section"> 155 <table class="members"> 156 <tr> 157 <td width="100"> </td> 158 <th> 159<span class="argument"><a href="../../../nn/cfg/CTR/CFG_PARENTAL_CONTROL_PIN_CODE_LENGTH.html"><CODE>CFG_PARENTAL_CONTROL_PIN_CODE_LENGTH</CODE></a></span> 160 </th> 161<td width="100">const <a href="../../../nn_types/u8.html">u8</a></td> 162<td>The string length of the Parental Controls PIN.</td> 163 </tr> 164 <tr> 165 <td width="100"> </td> 166 <th> 167<span class="argument"><a href="../../../nn/cfg/CTR/CFG_USER_NAME_LENGTH.html"><CODE>CFG_USER_NAME_LENGTH</CODE></a></span> 168 </th> 169<td width="100">const <a href="../../../nn_types/u8.html">u8</a></td> 170<td>The maximum string length of the user name. (Including the terminator.)</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175<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> 176 </th> 177<td width="100">const <a href="../../../nn_types/u8.html">u8</a></td> 178<td>Indicates the country code storage location in a <CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID.</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_REGION_SHIFT.html"><CODE>CFG_SIMPLE_ADDRESS_ID_REGION_SHIFT</CODE></a></span> 184 </th> 185<td width="100">const <a href="../../../nn_types/u8.html">u8</a></td> 186<td>Indicates the region code storage location in a <CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID.</td> 187 </tr> 188 <tr> 189 <td width="100"> </td> 190 <th> 191<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> 192 </th> 193<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 194<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID for a country code mask.</td> 195 </tr> 196 <tr> 197 <td width="100"> </td> 198 <th> 199<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> 200 </th> 201<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 202<td>Region code mask in a <CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE>.</td> 203 </tr> 204 <tr> 205 <td width="100"> </td> 206 <th> 207<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> 208 </th> 209<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 210<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> ID for a reserved region mask.</td> 211 </tr> 212 <tr> 213 <td width="100"> </td> 214 <th> 215<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> 216 </th> 217<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 218<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined ID.</td> 219 </tr> 220 <tr> 221 <td width="100"> </td> 222 <th> 223<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> 224 </th> 225<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 226<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined country code.</td> 227 </tr> 228 <tr> 229 <td width="100"> </td> 230 <th> 231<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> 232 </th> 233<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 234<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined country code.</td> 235 </tr> 236 <tr> 237 <td width="100"> </td> 238 <th> 239<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> 240 </th> 241<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 242<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined region code.</td> 243 </tr> 244 <tr> 245 <td width="100"> </td> 246 <th> 247<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> 248 </th> 249<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 250<td><CODE><a href="../../../nn/cfg/CTR/SimpleAddress/Overview.html">SimpleAddress</a></CODE> undefined region code.</td> 251 </tr> 252 <tr> 253 <td width="100"> </td> 254 <th> 255<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_NUM_LANGUAGES.html"><CODE>CFG_SIMPLE_ADDRESS_NUM_LANGUAGES</CODE></a></span> 256 </th> 257<td width="100">const <a href="../../../nn_types/u8.html">u8</a></td> 258<td>The number of languages for country/region names in simple address information.</td> 259 </tr> 260 <tr> 261 <td width="100"> </td> 262 <th> 263<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_NAME_LENGTH.html"><CODE>CFG_SIMPLE_ADDRESS_NAME_LENGTH</CODE></a></span> 264 </th> 265<td width="100">const <a href="../../../nn_types/u8.html">u8</a></td> 266<td>The maximum length of country/region names in simple address information.</td> 267 </tr> 268 <tr> 269 <td width="100"> </td> 270 <th> 271<span class="argument"><a href="../../../nn/cfg/CTR/CFG_SIMPLE_ADDRESS_WORKMEMORY_SIZE.html">CFG_SIMPLE_ADDRESS_WORKMEMORY_SIZE</a></span> 272 </th> 273<td width="100">const <a href="../../../nn_types/u32.html">u32</a></td> 274<td>The size of memory required to get simple address information.</td> 275 </tr> </table> 276 </div> 277 </a> <a name="function" id="function"> 278<h2>Functions</h2> 279 <div class="section"> 280 <table class="members"> 281 <tr> 282 <td width="100"> </td> 283 <th> 284<a href="../../../nn/cfg/CTR/Initialize.html"><CODE>Initialize</CODE></a> 285 </th> 286<td>Initializes the System Settings library.</td> 287 </tr> 288 <tr> 289 <td width="100"> </td> 290 <th> 291<a href="../../../nn/cfg/CTR/Finalize.html"><CODE>Finalize</CODE></a> 292 </th> 293<td>Finalizes use of the System Settings library.</td> 294 </tr> 295 <tr> 296 <td width="100"> </td> 297 <th> 298<a href="../../../nn/cfg/CTR/GetUserName.html"><CODE>GetUserName</CODE></a> 299 </th> 300<td>Gets the user name.</td> 301 </tr> 302 <tr> 303 <td width="100"> </td> 304 <th> 305<a href="../../../nn/cfg/CTR/GetBirthday.html"><CODE>GetBirthday</CODE></a> 306 </th> 307<td>Gets the birthday.</td> 308 </tr> 309 <tr> 310 <td width="100"> </td> 311 <th> 312<a href="../../../nn/cfg/CTR/GetCountry.html"><CODE>GetCountry</CODE></a> 313 </th> 314<td>Gets the country code.</td> 315 </tr> 316 <tr> 317 <td width="100"> </td> 318 <th> 319<a href="../../../nn/cfg/CTR/GetCountryCodeA2.html"><CODE>GetCountryCodeA2</CODE></a> 320 </th> 321<td>Converts the country code to <CODE>ISO 3166-1 alpha-2</CODE> format. This API is fast because it returns the value in memory.</td> 322 </tr> 323 <tr> 324 <td width="100"> </td> 325 <th> 326<a href="../../../nn/cfg/CTR/GetLanguage.html"><CODE>GetLanguage</CODE></a> 327 </th> 328<td>Gets the language code.</td> 329 </tr> 330 <tr> 331 <td width="100"> </td> 332 <th> 333<a href="../../../nn/cfg/CTR/GetLanguageCodeA2.html"><CODE>GetLanguageCodeA2</CODE></a> 334 </th> 335<td>Converts a language code to ISO 639-1 alpha-2 format. This API is fast because it returns the value in memory.</td> 336 </tr> 337 <tr> 338 <td width="100"> </td> 339 <th> 340<a href="../../../nn/cfg/CTR/GetSimpleAddress.html"><CODE>GetSimpleAddress</CODE></a> 341 </th> 342<td>Gets the simple address information (such as the country and region name) that has been set by System Settings.</td> 343 </tr> 344 <tr> 345 <td width="100"> </td> 346 <th> 347<a href="../../../nn/cfg/CTR/GetSimpleAddressId.html"><CODE>GetSimpleAddressId</CODE></a> 348 </th> 349<td>Gets only the ID from simple address information.</td> 350 </tr> 351 <tr> 352 <td width="100"> </td> 353 <th> 354<a href="../../../nn/cfg/CTR/GetRegion.html"><CODE>GetRegion</CODE></a> 355 </th> 356<td>Gets the region code of the system's market.</td> 357 </tr> 358 <tr> 359 <td width="100"> </td> 360 <th> 361<a href="../../../nn/cfg/CTR/GetRegionCodeA3.html"><CODE>GetRegionCodeA3</CODE></a> 362 </th> 363<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> 364 </tr> 365 <tr> 366 <td width="100"> </td> 367 <th> 368<a href="../../../nn/cfg/CTR/GetSoundOutputMode.html"><CODE>GetSoundOutputMode</CODE></a> 369 </th> 370<td>Gets the sound output mode.</td> 371 </tr> 372 <tr> 373 <td width="100"> </td> 374 <th> 375<a href="../../../nn/cfg/CTR/GetUserTimeOffset.html"><CODE>GetUserTimeOffset</CODE></a> 376 </th> 377<td>Gets RTC modification offset information.</td> 378 </tr> 379 <tr> 380 <td width="100"> </td> 381 <th> 382<a href="../../../nn/cfg/CTR/IsCoppacsSupported.html"><CODE>IsCoppacsSupported</CODE></a> 383 </th> 384<td>Gets whether the current System Settings support COPPACS.</td> 385 </tr> 386 <tr> 387 <td width="100"> </td> 388 <th> 389<a href="../../../nn/cfg/CTR/GetCoppacsRestriction.html"><CODE>GetCoppacsRestriction</CODE></a> 390 </th> 391<td>Gets <CODE>COPPACS</CODE> restrictions.</td> 392 </tr> 393 <tr> 394 <td width="100"> </td> 395 <th> 396<a href="../../../nn/cfg/CTR/CheckParentalControlPinCode.html"><CODE>CheckParentalControlPinCode</CODE></a> 397 </th> 398<td>Verifies the Parental Controls PIN code.</td> 399 </tr> 400 <tr> 401 <td width="100"> </td> 402 <th> 403<a href="../../../nn/cfg/CTR/IsRestrictPhotoExchange.html"><CODE>IsRestrictPhotoExchange</CODE></a> 404 </th> 405<td>Gets whether photo exchange is restricted by Parental Controls.</td> 406 </tr> 407 <tr> 408 <td width="100"> </td> 409 <th> 410<a href="../../../nn/cfg/CTR/IsRestrictAddFriend.html"><CODE>IsRestrictAddFriend</CODE></a> 411 </th> 412<td>Gets whether adding friends is restricted by Parental Controls.</td> 413 </tr> 414 <tr> 415 <td width="100"> </td> 416 <th> 417<a href="../../../nn/cfg/CTR/IsRestrictP2pInternet.html"><CODE>IsRestrictP2pInternet</CODE></a> 418 </th> 419<td>Gets whether Internet communication with other users is restricted by Parental Controls.</td> 420 </tr> 421 <tr> 422 <td width="100"> </td> 423 <th> 424<a href="../../../nn/cfg/CTR/IsRestrictP2pCec.html"><CODE>IsRestrictP2pCec</CODE></a> 425 </th> 426<td>Gets whether StreetPass communication with other users is restricted by Parental Controls.</td> 427 </tr> 428 <tr> 429 <td width="100"> </td> 430 <th> 431<a href="../../../nn/cfg/CTR/IsRestrictShopUse.html"><CODE>IsRestrictShopUse</CODE></a> 432 </th> 433<td>Gets whether use of the Nintendo eShop is restricted by Parental Controls.</td> 434 </tr> 435 <tr> 436 <td width="100"> </td> 437 <th> 438<a href="../../../nn/cfg/CTR/IsAgreedEula.html"><CODE>IsAgreedEula</CODE></a> 439 </th> 440<td>Obtains whether the user has agreed to the EULA.</td> 441 </tr> 442 <tr> 443 <td width="100"> </td> 444 <th> 445<a href="../../../nn/cfg/CTR/GetTransferableId.html"><CODE>GetTransferableId</CODE></a> 446 </th> 447<td>Gets the system ID.</td> 448 </tr> </table> 449 </div> 450 </a> 451<h2>Revision History</h2> 452 <div class="section"> 453 <dl class="history"> 454 <dt>2010/05/27</dt> 455<dd>Initial version.<br /> 456 </dd> 457 </dl> 458 </div> 459 <hr><p>CONFIDENTIAL</p></body> 460</html>