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