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