nn::applet::CTR Namespace

Description

The CTR applet namespace.
(This can also be written without the ::CTR portion.)

Classes

nn::applet::CTR::ResultNotFound Indicates an attempt to get something that did not exist.
nn::applet::CTR::ResultAlreadyExist Indicates an attempt to create or register something that already exists.
nn::applet::CTR::ResultNoArea Indicates a lack of free space during an attempt to run a process that required a region or resource.
nn::applet::CTR::ResultNotEmpty Indicates that during an attempt to run a process, a required buffer was in use and not empty.
nn::applet::CTR::ResultNoData Indicates that there was no data.
nn::applet::CTR::ResultNoCaller Indicates that the caller or sender does not exist.
nn::applet::CTR::ResultNotAllowed Indicates that processing was attempted from a state in which it was not allowed.
nn::applet::CTR::ResultBusy 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.
nn::applet::CTR::ResultAlreadyInit Indicates that initialization has already been done.
nn::applet::CTR::ResultDifferentMode Indicates differing modes.
nn::applet::CTR::ResultDifferentVersion Indicates differing versions.
nn::applet::CTR::ResultTransitionBusy Indicates that another transition is in progress.

Enumerated Types

HomeButtonState Enumerated type indicating the state of the HOME Button.
SleepNotificationState Enumerated type indicating the sleep notification state.
WakeupState Enumerated type indicating wakeup requests.
QueryReply Enumerated type indicating a response to a sleep query.
ResultDescription Module-dependent Description values for nn::Result.

typedef Definitions

AppletId The Applet ID.
AppletAttr The Applet attributes.
AppletHomeButtonCallback The type of the callback function invoked when HOME is pressed.
AppletMessageCallback The type of the callback function invoked when a message is received.
AppletSleepQueryCallback The type of the callback function invoked by a sleep query.
AppletSleepCanceledCallback Function type representing a sleep cancel callback.
AppletAwakeCallback The type of the callback function invoked upon awaking from sleep states.
AppletShutdownCallback The type of the callback function invoked when a shutdown notification occurs.
AppletCloseAppletCallback The type of the callback function invoked when the Applet is closed.
AppletPowerButtonCallback The type of the callback function invoked when POWER is pressed.
AppletTransitionCallback The type of the callback function invoked during a state transition.

Constants

WAIT_INFINITE The function continues running until a result is obtained. (Used by applet library functions that specify a time.)
NO_WAIT The function only runs once and does not repeat even if no results are obtained. (Used by applet library functions that specify a time.)

Functions

Initialization
Initialize Initializes the applet library.
Enable Enables applet library features.
Getting Information
ReceiveDeliverArg Gets DeliverArg and HMAC information as well as the UniqueId for transmissions.
GetInitialWakeupState Gets "wakeup" information when an application is launched.
IsActive Determines whether an Applet is currently running.
Controlling Operations
WaitForRegister Waits the allotted time for the Applet with the specified ID to be registered.
WaitForStarting Waits for this object's start event.
Rendering Rights
AssignGpuRight Declares that an Applet will start rendering.
ReleaseGpuRight Declares that rendering will switch from the Applet back to the program.
Power Button
IsExpectedToProcessPowerButton Finds the state of the POWER Button.
Exiting Programs
PrepareToCloseApplication Prepares to exit a program.
CloseApplication Exits the program.
HOME Menu
GetHomeButtonState Gets the state of the HOME Button.
ClearHomeButtonState Clears the HOME Button state.
IsExpectedToProcessHomeButton Determines whether there has been a request to process the HOME Button.
ProcessHomeButton Processes transitions to the HOME Menu.
Sleep
GetSleepNotificationState Gets the sleep notification state.
ClearSleepNotificationState Clears the sleep notification state.
ReplySleepQuery Replies to a sleep query.
Callback Settings
SetHomeButtonCallback Sets the callback invoked when HOME is pressed.
SetReceiveMessageCallback Sets the callback invoked when a message is received.
SetPowerButtonCallback Sets the callback invoked when POWER is pressed.
SetSleepQueryCallback Sets the sleep query callback.
SetSleepCanceledCallback Sets the sleep cancel callback.
SetAwakeCallback Sets a sleep recovery callback.
SetShutdownCallback Sets the shutdown notification callback.
SetTransitionCallback Sets the callback to invoke when control jumps from the application to either the HOME Menu or a system applet.
Other
EnableSleep Enables going to sleep.
DisableSleep Prevents going to sleep.

Revision History

2010/11/10
Initial version.

CONFIDENTIAL