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