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> 57 </div> 58 <a name="enum" id="enum"> 59 <h2>Enumerated Types</h2> 60 <div class="section"> 61 <table class="members"> 62 <tr> 63 <td width="100"> </td> 64 <th> 65 <a href="../../../nn/applet/CTR/HomeButtonState.html"><CODE>HomeButtonState</CODE></a> 66 </th> 67 <td>An enumerated type indicating the state of the HOME Button.</td> 68 </tr> 69 <tr> 70 <td width="100"> </td> 71 <th> 72 <a href="../../../nn/applet/CTR/SleepNotificationState.html"><CODE>SleepNotificationState</CODE></a> 73 </th> 74 <td>An enumerated type indicating the sleep notification state.</td> 75 </tr> 76 <tr> 77 <td width="100"> </td> 78 <th> 79 <a href="../../../nn/applet/CTR/WakeupState.html"><CODE>WakeupState</CODE></a> 80 </th> 81 <td>Enumerated type representing start requests.</td> 82 </tr> 83 <tr> 84 <td width="100"> </td> 85 <th> 86 <a href="../../../nn/applet/CTR/QueryReply.html"><CODE>QueryReply</CODE></a> 87 </th> 88 <td>Enumerated type indicating a response to a sleep query.</td> 89 </tr> 90 <tr> 91 <td width="100"> </td> 92 <th> 93 <a href="../../../nn/applet/CTR/ResultDescription.html"><CODE>ResultDescription</CODE></a> 94 </th> 95 <td>Module-dependent <CODE>Description</CODE> values for <a href="../../../nn/Result/Overview.html"><CODE>nn::Result</CODE></a>.</td> 96 </tr> </table> 97 </div> 98 </a> <a name="typedef" id="typedef"> 99 <h2><CODE>typedef</CODE> Definitions</h2> 100 <div class="section"> 101 <table class="members"> 102 <tr> 103 <td width="100" /> 104 <th> 105 <a href="../../../nn/applet/CTR/AppletId.html"><CODE>AppletId</CODE></a> 106 </th> 107 <td>An applet ID.</td> 108 </tr> 109 <tr> 110 <td width="100" /> 111 <th> 112 <a href="../../../nn/applet/CTR/AppletAttr.html"><CODE>AppletAttr</CODE></a> 113 </th> 114 <td>APPLET attributes.</td> 115 </tr> 116 <tr> 117 <td width="100" /> 118 <th> 119 <a href="../../../nn/applet/CTR/AppletHomeButtonCallback.html"><CODE>AppletHomeButtonCallback</CODE></a> 120 </th> 121 <td>A function type that represents a callback invoked when a HOME Button press is detected.</td> 122 </tr> 123 <tr> 124 <td width="100" /> 125 <th> 126 <a href="../../../nn/applet/CTR/AppletMessageCallback.html"><CODE>AppletMessageCallback</CODE></a> 127 </th> 128 <td>A function type that represents a callback for receiving messages.</td> 129 </tr> 130 <tr> 131 <td width="100" /> 132 <th> 133 <a href="../../../nn/applet/CTR/AppletSleepQueryCallback.html"><CODE>AppletSleepQueryCallback</CODE></a> 134 </th> 135 <td>A function type that represents a sleep query callback.</td> 136 </tr> 137 <tr> 138 <td width="100" /> 139 <th> 140 <a href="../../../nn/applet/CTR/AppletSleepCallback.html"><CODE>AppletSleepCallback</CODE></a> 141 </th> 142 <td>A function type that represents a sleep callback. (This type is expected to be removed.)</td> 143 </tr> 144 <tr> 145 <td width="100" /> 146 <th> 147 <a href="../../../nn/applet/CTR/AppletAwakeCallback.html"><CODE>AppletAwakeCallback</CODE></a> 148 </th> 149 <td>A function type that represents a callback invoked upon recovering from Sleep Mode.</td> 150 </tr> 151 <tr> 152 <td width="100" /> 153 <th> 154 <a href="../../../nn/applet/CTR/AppletShutdownCallback.html"><CODE>AppletShutdownCallback</CODE></a> 155 </th> 156 <td>A function type that represents a shutdown notification callback.</td> 157 </tr> 158 <tr> 159 <td width="100" /> 160 <th> 161 <a href="../../../nn/applet/CTR/AppletCloseAppletCallback.html"><CODE>AppletCloseAppletCallback</CODE></a> 162 </th> 163 <td>A function type that represents a callback invoked when an application exits.</td> 164 </tr> 165 <tr> 166 <td width="100" /> 167 <th> 168 <a href="../../../nn/applet/CTR/AppletPowerButtonCallback.html"><CODE>AppletPowerButtonCallback</CODE></a> 169 </th> 170 <td>A function type that represents a callback invoked when a POWER Button press is detected.</td> 171 </tr> </table> 172 </div> 173 </a> <a name="constant" id="constant"> 174 <h2>Constants</h2> 175 <div class="section"> 176 <table class="members"> 177 <tr> 178 <td width="100"> </td> 179 <th> 180 <span class="argument"><a href="./WAIT_INFINITE.html"><CODE>WAIT_INFINITE</CODE></a></span> 181 </th> 182 <td>Used by APPLET library functions that specify a time. This means that a function will continue running until a result is obtained.</td> 183 </tr> 184 <tr> 185 <td width="100"> </td> 186 <th> 187 <span class="argument"><a href="./NO_WAIT.html"><CODE>NO_WAIT</CODE></a></span> 188 </th> 189 <td>Used by APPLET library functions that specify a time. This means that a function will only run once without repeating, even if no results are obtained.</td> 190 </tr> </table> 191 </div> 192 </a> <a name="function" id="function"> 193 <h2>Functions</h2> 194 <div class="section"> 195 <table class="members"> 196 <tr> 197 <th class="category" colspan="3">Initialization</th> 198 </tr> 199 <tr> 200 <td width="100"> </td> 201 <th> 202 <a href="../../../nn/applet/CTR/Initialize.html"><CODE>Initialize</CODE></a> 203 </th> 204 <td>Initializes the APPLET library.</td> 205 </tr> 206 <tr> 207 <th class="category" colspan="3">Getting Information</th> 208 </tr> 209 <tr> 210 <td width="100"> </td> 211 <th> 212 <a href="../../../nn/applet/CTR/ReceiveDeliverArg.html"><CODE>ReceiveDeliverArg</CODE></a> 213 </th> 214 <td>Gets <CODE>DeliverArg</CODE> and HMAC information.</td> 215 </tr> 216 <tr> 217 <td width="100"> </td> 218 <th> 219 <a href="../../../nn/applet/CTR/IsRegistered.html"><CODE>IsRegistered</CODE></a> 220 </th> 221 <td>Determines whether the applet with the specified ID has been registered.</td> 222 </tr> 223 <tr> 224 <td width="100"> </td> 225 <th> 226 <a href="../../../nn/applet/CTR/IsActive.html"><CODE>IsActive</CODE></a> 227 </th> 228 <td>Determines whether an application is currently running.</td> 229 </tr> 230 <tr> 231 <th class="category" colspan="3">Controlling Operations</th> 232 </tr> 233 <tr> 234 <td width="100"> </td> 235 <th> 236 <a href="../../../nn/applet/CTR/WaitForRegister.html"><CODE>WaitForRegister</CODE></a> 237 </th> 238 <td>Waits only the specified amount of time for the applet with the specified ID to be registered.</td> 239 </tr> 240 <tr> 241 <td width="100"> </td> 242 <th> 243 <a href="../../../nn/applet/CTR/WaitForStarting.html"><CODE>WaitForStarting</CODE></a> 244 </th> 245 <td>Waits for this object's start event.</td> 246 </tr> 247 <tr> 248 <th class="category" colspan="3">Rendering Rights</th> 249 </tr> 250 <tr> 251 <td width="100"> </td> 252 <th> 253 <a href="../../../nn/applet/CTR/AssignGpuRight.html"><CODE>AssignGpuRight</CODE></a> 254 </th> 255 <td>Declares that an application will start rendering.</td> 256 </tr> 257 <tr> 258 <td width="100"> </td> 259 <th> 260 <a href="../../../nn/applet/CTR/ReleaseGpuRight.html"><CODE>ReleaseGpuRight</CODE></a> 261 </th> 262 <td>Declares that rendering will switch from the application to another program.</td> 263 </tr> 264 <tr> 265 <th class="category" colspan="3">Preloading and Exiting Library Applets</th> 266 </tr> 267 <tr> 268 <td width="100"> </td> 269 <th> 270 <a href="../../../nn/applet/CTR/PreloadLibraryApplet.html"><CODE>PreloadLibraryApplet</CODE></a> 271 </th> 272 <td>Preloads a library applet to be run.</td> 273 </tr> 274 <tr> 275 <td width="100"> </td> 276 <th> 277 <a href="../../../nn/applet/CTR/CancelLibraryApplet.html"><CODE>CancelLibraryApplet</CODE></a> 278 </th> 279 <td>Exits a preloaded library applet.</td> 280 </tr> 281 <tr> 282 <th class="category" colspan="3">Starting Library Applets</th> 283 </tr> 284 <tr> 285 <td width="100"> </td> 286 <th> 287 <a href="../../../nn/applet/CTR/PrepareToStartLibraryApplet.html"><CODE>PrepareToStartLibraryApplet</CODE></a> 288 </th> 289 <td>Prepares to start a library applet.</td> 290 </tr> 291 <tr> 292 <td width="100"> </td> 293 <th> 294 <a href="../../../nn/applet/CTR/StartLibraryApplet.html"><CODE>StartLibraryApplet</CODE></a> 295 </th> 296 <td>Starts a library applet.</td> 297 </tr> 298 <tr> 299 <th class="category" colspan="3">Exiting Applications</th> 300 </tr> 301 <tr> 302 <td width="100"> </td> 303 <th> 304 <a href="../../../nn/applet/CTR/PrepareToCloseApplication.html"><CODE>PrepareToCloseApplication</CODE></a> 305 </th> 306 <td>Prepares to exit an application.</td> 307 </tr> 308 <tr> 309 <td width="100"> </td> 310 <th> 311 <a href="../../../nn/applet/CTR/CloseApplication.html"><CODE>CloseApplication</CODE></a> 312 </th> 313 <td>Exits the application.</td> 314 </tr> 315 <tr> 316 <th class="category" colspan="3">HOME Menu</th> 317 </tr> 318 <tr> 319 <td width="100"> </td> 320 <th> 321 <a href="../../../nn/applet/CTR/PrepareToJumpToHomeMenu.html"><CODE>PrepareToJumpToHomeMenu</CODE></a> 322 </th> 323 <td>Prepares to jump to the HOME Menu.</td> 324 </tr> 325 <tr> 326 <td width="100"> </td> 327 <th> 328 <a href="../../../nn/applet/CTR/JumpToHomeMenu.html"><CODE>JumpToHomeMenu</CODE></a> 329 </th> 330 <td>Jumps to the HOME Menu.</td> 331 </tr> 332 <tr> 333 <td width="100"> </td> 334 <th> 335 <a href="../../../nn/applet/CTR/ProcessHomeButtonIfPrepared.html"><CODE>ProcessHomeButtonIfPrepared</CODE></a> 336 </th> 337 <td>Processes the HOME Button.</td> 338 </tr> 339 <tr> 340 <th class="category" colspan="3">HOME Button</th> 341 </tr> 342 <tr> 343 <td width="100"> </td> 344 <th> 345 <a href="../../../nn/applet/CTR/GetHomeButtonState.html"><CODE>GetHomeButtonState</CODE></a> 346 </th> 347 <td>Gets the state of the HOME Button.</td> 348 </tr> 349 <tr> 350 <td width="100"> </td> 351 <th> 352 <a href="../../../nn/applet/CTR/ClearHomeButtonState.html"><CODE>ClearHomeButtonState</CODE></a> 353 </th> 354 <td>Clears the HOME Button state.</td> 355 </tr> 356 <tr> 357 <th class="category" colspan="3">Sleep</th> 358 </tr> 359 <tr> 360 <td width="100"> </td> 361 <th> 362 <a href="../../../nn/applet/CTR/GetSleepNotificationState.html"><CODE>GetSleepNotificationState</CODE></a> 363 </th> 364 <td>Gets the sleep notification state.</td> 365 </tr> 366 <tr> 367 <td width="100"> </td> 368 <th> 369 <a href="../../../nn/applet/CTR/ClearSleepNotificationState.html"><CODE>ClearSleepNotificationState</CODE></a> 370 </th> 371 <td>Clears the sleep notification state.</td> 372 </tr> 373 <tr> 374 <td width="100"> </td> 375 <th> 376 <a href="../../../nn/applet/CTR/ReplySleepQuery.html"><CODE>ReplySleepQuery</CODE></a> 377 </th> 378 <td>Replies to a sleep query.</td> 379 </tr> 380 <tr> 381 <th class="category" colspan="3">Callback Settings</th> 382 </tr> 383 <tr> 384 <td width="100"> </td> 385 <th> 386 <a href="../../../nn/applet/CTR/SetHomeButtonCallback.html"><CODE>SetHomeButtonCallback</CODE></a> 387 </th> 388 <td>Sets the callback invoked when a HOME Button press is detected.</td> 389 </tr> 390 <tr> 391 <td width="100"> </td> 392 <th> 393 <a href="../../../nn/applet/CTR/SetReceiveMessageCallback.html"><CODE>SetReceiveMessageCallback</CODE></a> 394 </th> 395 <td>Sets the callback invoked when a message is received.</td> 396 </tr> 397 <tr> 398 <td width="100"> </td> 399 <th> 400 <a href="../../../nn/applet/CTR/SetPowerButtonCallback.html"><CODE>SetPowerButtonCallback</CODE></a> 401 </th> 402 <td>Sets the callback invoked when a POWER Button press is detected.</td> 403 </tr> 404 <tr> 405 <td width="100"> </td> 406 <th> 407 <a href="../../../nn/applet/CTR/SetSleepQueryCallback.html"><CODE>SetSleepQueryCallback</CODE></a> 408 </th> 409 <td>Sets the sleep query callback.</td> 410 </tr> 411 <tr> 412 <td width="100"> </td> 413 <th> 414 <a href="../../../nn/applet/CTR/SetSleepCallback.html"><CODE>SetSleepCallback</CODE></a> 415 </th> 416 <td>Sets the sleep callback.</td> 417 </tr> 418 <tr> 419 <td width="100"> </td> 420 <th> 421 <a href="../../../nn/applet/CTR/SetAwakeCallback.html"><CODE>SetAwakeCallback</CODE></a> 422 </th> 423 <td>Sets a sleep recovery callback.</td> 424 </tr> 425 <tr> 426 <td width="100"> </td> 427 <th> 428 <a href="../../../nn/applet/CTR/SetShutdownCallback.html"><CODE>SetShutdownCallback</CODE></a> 429 </th> 430 <td>Sets the shutdown notification callback.</td> 431 </tr> 432 <tr> 433 <td width="100"> </td> 434 <th> 435 <a href="../../../nn/applet/CTR/SetCloseAppletCallback.html"><CODE>SetCloseAppletCallback</CODE></a> 436 </th> 437 <td>Sets the callback invoked when an applet exits.</td> 438 </tr> </table> 439 </div> 440 </a> 441 <hr><p>CONFIDENTIAL</p></body> 442</html>