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