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::applet::CTR</title> 51 </head> 52 <body> 53<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/applet/Overview.html">applet</a>::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>The <a href="../../../nn/applet/CTR/Overview.html">CTR</a> applet namespace. <br />(This can also be written without the <CODE>::CTR</CODE> portion.)</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> 63<a href="../../../nn/applet/CTR/ResultNotFound/Overview.html"><CODE>nn::applet::CTR::ResultNotFound</CODE></a> 64 </th> 65<td>Indicates an attempt to get something that did not exist.</td> 66 </tr> 67 <tr> 68 <th> 69<a href="../../../nn/applet/CTR/ResultAlreadyExist/Overview.html"><CODE>nn::applet::CTR::ResultAlreadyExist</CODE></a> 70 </th> 71<td>Indicates an attempt to create or register something that already exists.</td> 72 </tr> 73 <tr> 74 <th> 75<a href="../../../nn/applet/CTR/ResultNoArea/Overview.html"><CODE>nn::applet::CTR::ResultNoArea</CODE></a> 76 </th> 77<td>Indicates a lack of free space during an attempt to run a process that required a region or resource.</td> 78 </tr> 79 <tr> 80 <th> 81<a href="../../../nn/applet/CTR/ResultNotEmpty/Overview.html"><CODE>nn::applet::CTR::ResultNotEmpty</CODE></a> 82 </th> 83<td>Indicates that during an attempt to run a process, a required buffer was in use and not empty.</td> 84 </tr> 85 <tr> 86 <th> 87<a href="../../../nn/applet/CTR/ResultNoData/Overview.html"><CODE>nn::applet::CTR::ResultNoData</CODE></a> 88 </th> 89<td>Indicates that there was no data.</td> 90 </tr> 91 <tr> 92 <th> 93<a href="../../../nn/applet/CTR/ResultNoCaller/Overview.html"><CODE>nn::applet::CTR::ResultNoCaller</CODE></a> 94 </th> 95<td>Indicates that the caller or sender does not exist.</td> 96 </tr> 97 <tr> 98 <th> 99<a href="../../../nn/applet/CTR/ResultNotAllowed/Overview.html"><CODE>nn::applet::CTR::ResultNotAllowed</CODE></a> 100 </th> 101<td>Indicates that processing was attempted from a state in which it was not allowed.</td> 102 </tr> 103 <tr> 104 <th> 105<a href="../../../nn/applet/CTR/ResultBusy/Overview.html"><CODE>nn::applet::CTR::ResultBusy</CODE></a> 106 </th> 107<td>Indicates an attempt to run a process that was busy because of a mutex or for some other reason. In this case, you can retry the process.</td> 108 </tr> 109 <tr> 110 <th> 111<a href="../../../nn/applet/CTR/ResultAlreadyInit/Overview.html"><CODE>nn::applet::CTR::ResultAlreadyInit</CODE></a> 112 </th> 113<td>Indicates that initialization has already been done.</td> 114 </tr> 115 <tr> 116 <th> 117<a href="../../../nn/applet/CTR/ResultNotInitialized/Overview.html"><CODE>nn::applet::CTR::ResultNotInitialized</CODE></a> 118 </th> 119<td>Indicates that initialization has already been done.</td> 120 </tr> 121 <tr> 122 <th> 123<a href="../../../nn/applet/CTR/ResultDifferentMode/Overview.html"><CODE>nn::applet::CTR::ResultDifferentMode</CODE></a> 124 </th> 125<td>Indicates differing modes.</td> 126 </tr> 127 <tr> 128 <th> 129<a href="../../../nn/applet/CTR/ResultDifferentVersion/Overview.html"><CODE>nn::applet::CTR::ResultDifferentVersion</CODE></a> 130 </th> 131<td>Indicates differing versions.</td> 132 </tr> 133 <tr> 134 <th> 135<a href="../../../nn/applet/CTR/ResultTransitionBusy/Overview.html"><CODE>nn::applet::CTR::ResultTransitionBusy</CODE></a> 136 </th> 137<td>Indicates that another transition is in progress.</td> 138 </tr> 139 <tr> 140 <th> 141<a href="../../../nn/applet/CTR/ResultShutdownProcessing/Overview.html"><CODE>nn::applet::CTR::ResultShutdownProcessing</CODE></a> 142 </th> 143<td>Indicates that a shutdown is in process.</td> 144 </tr> 145 <tr> 146 <th> 147<a href="../../../nn/applet/CTR/ResultVersionMustLaunchDirectly/Overview.html"><CODE>nn::applet::CTR::ResultVersionMustLaunchDirectly</CODE></a> 148 </th> 149<td>Indicates that the version requires direct startup without using menus.</td> 150 </tr> </table> 151 </div> 152 </a> <a name="enum" id="enum"> 153<h2>Enumerated Types</h2> 154 <div class="section"> 155 <table class="members"> 156 <tr> 157 <td width="100"> </td> 158 <th> 159<a href="../../../nn/applet/CTR/HomeButtonState.html"><CODE>HomeButtonState</CODE></a> 160 </th> 161<td>Enumerated type indicating the state of the HOME Button.</td> 162 </tr> 163 <tr> 164 <td width="100"> </td> 165 <th> 166<a href="../../../nn/applet/CTR/WakeupState.html"><CODE>WakeupState</CODE></a> 167 </th> 168<td>Enumerated type indicating wakeup requests.</td> 169 </tr> 170 <tr> 171 <td width="100"> </td> 172 <th> 173<a href="../../../nn/applet/CTR/QueryReply.html"><CODE>QueryReply</CODE></a> 174 </th> 175<td>Enumerated type indicating a response to a sleep query.</td> 176 </tr> 177 <tr> 178 <td width="100"> </td> 179 <th> 180<a href="../../../nn/applet/CTR/ResultDescription.html"><CODE>ResultDescription</CODE></a> 181 </th> 182<td>Module-dependent <CODE>Description</CODE> values for <a href="../../../nn/Result/Overview.html"><CODE>nn::Result</CODE></a>.</td> 183 </tr> </table> 184 </div> 185 </a> <a name="typedef" id="typedef"> 186<h2><CODE>typedef</CODE> Definitions</h2> 187 <div class="section"> 188 <table class="members"> 189 <tr> 190 <td width="100" /> 191 <th> 192<a href="../../../nn/applet/CTR/AppletId.html"><CODE>AppletId</CODE></a> 193 </th> 194<td>Applet ID.</td> 195 </tr> 196 <tr> 197 <td width="100" /> 198 <th> 199<a href="../../../nn/applet/CTR/AppletAttr.html"><CODE>AppletAttr</CODE></a> 200 </th> 201<td>The Applet attributes.</td> 202 </tr> 203 <tr> 204 <td width="100" /> 205 <th> 206<a href="../../../nn/applet/CTR/AppletHomeButtonCallback.html"><CODE>AppletHomeButtonCallback</CODE></a> 207 </th> 208<td>The type of the callback function invoked when HOME is pressed.</td> 209 </tr> 210 <tr> 211 <td width="100" /> 212 <th> 213<a href="../../../nn/applet/CTR/AppletSleepQueryCallback.html"><CODE>AppletSleepQueryCallback</CODE></a> 214 </th> 215<td>The type of the callback function invoked by a sleep query.</td> 216 </tr> 217 <tr> 218 <td width="100" /> 219 <th> 220<a href="../../../nn/applet/CTR/AppletSleepCanceledCallback.html"><CODE>AppletSleepCanceledCallback</CODE></a> 221 </th> 222<td>Function type representing a sleep cancel callback.</td> 223 </tr> 224 <tr> 225 <td width="100" /> 226 <th> 227<a href="../../../nn/applet/CTR/AppletAwakeCallback.html"><CODE>AppletAwakeCallback</CODE></a> 228 </th> 229<td>The type of the callback function invoked upon awaking from sleep states.</td> 230 </tr> 231 <tr> 232 <td width="100" /> 233 <th> 234<a href="../../../nn/applet/CTR/AppletPowerButtonCallback.html"><CODE>AppletPowerButtonCallback</CODE></a> 235 </th> 236<td>The type of the callback function invoked when POWER is pressed.</td> 237 </tr> </table> 238 </div> 239 </a> <a name="constant" id="constant"> 240<h2>Constants</h2> 241 <div class="section"> 242 <table class="members"> 243 <tr> 244 <td width="100"> </td> 245 <th> 246<span class="argument"><a href="../../../nn/applet/CTR/WAIT_INFINITE.html"><CODE>WAIT_INFINITE</CODE></a></span> 247 </th> 248<td width="100">const <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a></td> 249<td>The function continues running until a result is obtained. (Used by applet library functions that specify a time.)</td> 250 </tr> 251 <tr> 252 <td width="100"> </td> 253 <th> 254<span class="argument"><a href="../../../nn/applet/CTR/NO_WAIT.html"><CODE>NO_WAIT</CODE></a></span> 255 </th> 256<td width="100">const <a href="../../../nn/fnd/TimeSpan/Overview.html">nn::fnd::TimeSpan</a></td> 257<td>The function only runs once and does not repeat even if no results are obtained. (Used by applet library functions that specify a time.)</td> 258 </tr> </table> 259 </div> 260 </a> <a name="function" id="function"> 261<h2>Functions</h2> 262 <div class="section"> 263 <table class="members"> 264 <tr> 265<th class="category" colspan="3">Initialization</th> 266 </tr> 267 <tr> 268 <td width="100"> </td> 269 <th> 270<a href="../../../nn/applet/CTR/Enable.html"><CODE>Enable</CODE></a> 271 </th> 272<td>Enables features specific to the applet library.</td> 273 </tr> 274 <tr> 275<th class="category" colspan="3">Getting Information</th> 276 </tr> 277 <tr> 278 <td width="100"> </td> 279 <th> 280<a href="../../../nn/applet/CTR/GetInitialWakeupState.html"><CODE>GetInitialWakeupState</CODE></a> 281 </th> 282<td>Gets "wakeup" information when an application is launched.</td> 283 </tr> 284 <tr> 285 <td width="100"> </td> 286 <th> 287<a href="../../../nn/applet/CTR/IsActive.html"><CODE>IsActive</CODE></a> 288 </th> 289<td>Determines whether an Applet is currently running.</td> 290 </tr> 291 <tr> 292<th class="category" colspan="3">Controlling Operations</th> 293 </tr> 294 <tr> 295 <td width="100"> </td> 296 <th> 297<a href="../../../nn/applet/CTR/WaitForRegister.html"><CODE>WaitForRegister</CODE></a> 298 </th> 299<td>Waits for the Applet with the specified ID to be registered.</td> 300 </tr> 301 <tr> 302 <td width="100"> </td> 303 <th> 304<a href="../../../nn/applet/CTR/WaitForStarting.html"><CODE>WaitForStarting</CODE></a> 305 </th> 306<td>Waits for this object's start event.</td> 307 </tr> 308 <tr> 309<th class="category" colspan="3">Power Button</th> 310 </tr> 311 <tr> 312 <td width="100"> </td> 313 <th> 314<a href="../../../nn/applet/CTR/IsExpectedToProcessPowerButton.html"><CODE>IsExpectedToProcessPowerButton</CODE></a> 315 </th> 316<td>Finds the state of the POWER Button.</td> 317 </tr> 318 <tr> 319 <td width="100"> </td> 320 <th> 321<a href="../../../nn/applet/CTR/ProcessPowerButton.html"><CODE>ProcessPowerButton</CODE></a> 322 </th> 323<td>Processes POWER Button transitions.</td> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328<a href="../../../nn/applet/CTR/ProcessPowerButtonAndWait.html"><CODE>ProcessPowerButtonAndWait</CODE></a> 329 </th> 330<td>Processes power button transition, and goes into standby until activated.</td> 331 </tr> 332 <tr> 333<th class="category" colspan="3">Exiting Programs</th> 334 </tr> 335 <tr> 336 <td width="100"> </td> 337 <th> 338<a href="../../../nn/applet/CTR/IsExpectedToCloseApplication.html"><CODE>IsExpectedToCloseApplication</CODE></a> 339 </th> 340<td>Determines whether an application should be closed.</td> 341 </tr> 342 <tr> 343 <td width="100"> </td> 344 <th> 345<a href="../../../nn/applet/CTR/PrepareToCloseApplication.html"><CODE>PrepareToCloseApplication</CODE></a> 346 </th> 347<td>Prepares to exit a program.</td> 348 </tr> 349 <tr> 350 <td width="100"> </td> 351 <th> 352<a href="../../../nn/applet/CTR/CloseApplication.html"><CODE>CloseApplication</CODE></a> 353 </th> 354<td>Exits the program.</td> 355 </tr> 356 <tr> 357 <td width="100"> </td> 358 <th> 359<a href="../../../nn/applet/CTR/RestartApplication.html"><CODE>RestartApplication</CODE></a> 360 </th> 361<td>Terminates the application and then restarts it.</td> 362 </tr> 363 <tr> 364 <td width="100"> </td> 365 <th> 366<a href="../../../nn/applet/CTR/GetStartupArgument.html"><CODE>GetStartupArgument</CODE></a> 367 </th> 368<td>Gets the specified data when <CODE>RestartApplication</CODE> is called.</td> 369 </tr> 370 <tr> 371<th class="category" colspan="3">Calling up system settings</th> 372 </tr> 373 <tr> 374 <td width="100"> </td> 375 <th> 376<a href="../../../nn/applet/CTR/JumpToInternetSetting.html"><CODE>JumpToInternetSetting</CODE></a> 377 </th> 378<td>Jumps to Internet Settings in system settings.</td> 379 </tr> 380 <tr> 381 <td width="100"> </td> 382 <th> 383<a href="../../../nn/applet/CTR/JumpToParentalControls.html"><CODE>JumpToParentalControls</CODE></a> 384 </th> 385<td>Jumps to Parental Controls in system settings.</td> 386 </tr> 387 <tr> 388 <td width="100"> </td> 389 <th> 390<a href="../../../nn/applet/CTR/JumpToDataManagement.html"><CODE>JumpToDataManagement</CODE></a> 391 </th> 392<td>Jumps to Data Management under system settings.</td> 393 </tr> 394 <tr> 395 <td width="100"> </td> 396 <th> 397<a href="../../../nn/applet/CTR/IsFromMset.html"><CODE>IsFromMset</CODE></a> 398 </th> 399<td>Determines to return jump from system settings.</td> 400 </tr> 401 <tr> 402<th class="category" colspan="3">HOME Menu</th> 403 </tr> 404 <tr> 405 <td width="100"> </td> 406 <th> 407<a href="../../../nn/applet/CTR/GetHomeButtonState.html"><CODE>GetHomeButtonState</CODE></a> 408 </th> 409<td>Gets the state of the HOME Button.</td> 410 </tr> 411 <tr> 412 <td width="100"> </td> 413 <th> 414<a href="../../../nn/applet/CTR/ClearHomeButtonState.html"><CODE>ClearHomeButtonState</CODE></a> 415 </th> 416<td>Clears the HOME Button state.</td> 417 </tr> 418 <tr> 419 <td width="100"> </td> 420 <th> 421<a href="../../../nn/applet/CTR/IsExpectedToProcessHomeButton.html"><CODE>IsExpectedToProcessHomeButton</CODE></a> 422 </th> 423<td>Determines whether there has been a request to process the HOME Button.</td> 424 </tr> 425 <tr> 426 <td width="100"> </td> 427 <th> 428<a href="../../../nn/applet/CTR/ProcessHomeButton.html"><CODE>ProcessHomeButton</CODE></a> 429 </th> 430<td>Processes transitions to the HOME Menu.</td> 431 </tr> 432 <tr> 433 <td width="100"> </td> 434 <th> 435<a href="../../../nn/applet/CTR/ProcessHomeButtonAndWait.html"><CODE>ProcessHomeButtonAndWait</CODE></a> 436 </th> 437<td>Processes HOME Menu transition, and goes into standby until activated.</td> 438 </tr> 439 <tr> 440<th class="category" colspan="3">Sleep</th> 441 </tr> 442 <tr> 443 <td width="100"> </td> 444 <th> 445<a href="../../../nn/applet/CTR/IsExpectedToReplySleepQuery.html"><CODE>IsExpectedToReplySleepQuery</CODE></a> 446 </th> 447<td>Checks whether the sleep notification state is waiting for a reply.</td> 448 </tr> 449 <tr> 450 <td width="100"> </td> 451 <th> 452<a href="../../../nn/applet/CTR/ReplySleepQuery.html"><CODE>ReplySleepQuery</CODE></a> 453 </th> 454<td>Replies to a sleep query.</td> 455 </tr> 456 <tr> 457 <td width="100"> </td> 458 <th> 459<a href="../../../nn/applet/CTR/EnableSleep.html"><CODE>EnableSleep</CODE></a> 460 </th> 461<td>Enables Sleep Mode.</td> 462 </tr> 463 <tr> 464 <td width="100"> </td> 465 <th> 466<a href="../../../nn/applet/CTR/DisableSleep.html"><CODE>DisableSleep</CODE></a> 467 </th> 468<td>Prohibits Sleep Mode.</td> 469 </tr> 470 <tr> 471<th class="category" colspan="3">Callback Settings</th> 472 </tr> 473 <tr> 474 <td width="100"> </td> 475 <th> 476<a href="../../../nn/applet/CTR/SetHomeButtonCallback.html"><CODE>SetHomeButtonCallback</CODE></a> 477 </th> 478<td>Sets the callback invoked when HOME is pressed.</td> 479 </tr> 480 <tr> 481 <td width="100"> </td> 482 <th> 483<a href="../../../nn/applet/CTR/SetPowerButtonCallback.html"><CODE>SetPowerButtonCallback</CODE></a> 484 </th> 485<td>Sets the callback invoked when POWER is pressed.</td> 486 </tr> 487 <tr> 488 <td width="100"> </td> 489 <th> 490<a href="../../../nn/applet/CTR/SetSleepQueryCallback.html"><CODE>SetSleepQueryCallback</CODE></a> 491 </th> 492<td>Sets the sleep query callback.</td> 493 </tr> 494 <tr> 495 <td width="100"> </td> 496 <th> 497<a href="../../../nn/applet/CTR/SetSleepCanceledCallback.html"><CODE>SetSleepCanceledCallback</CODE></a> 498 </th> 499<td>Sets the sleep cancel callback.</td> 500 </tr> 501 <tr> 502 <td width="100"> </td> 503 <th> 504<a href="../../../nn/applet/CTR/SetAwakeCallback.html"><CODE>SetAwakeCallback</CODE></a> 505 </th> 506<td>Sets a sleep recovery callback.</td> 507 </tr> </table> 508 </div> 509 </a> 510<h2>Revision History</h2> 511 <div class="section"> 512 <dl class="history"> 513 <dt>2010/11/10</dt> 514<dd>Initial version.<br /> 515 </dd> 516 </dl> 517 </div> 518 <hr><p>CONFIDENTIAL</p></body> 519</html>