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