nn::applet::CTR::ProcessHomeButton Function

bool ProcessHomeButton(
     void
);

None.

Returns a value indicating whether it is necessary to wait.

Processes transitions to the HOME Menu.

This function is used to jump to the HOME Menu when this is required by the nn::applet::CTR::IsExpectedToProcessHomeButton function.

The return value indicates whether it is necessary to wait with the nn::applet::CTR::WaitForStarting function after this function is called. If this is true, call the function. If this is false, you do not need to call the function. (Of course, even if you call the function it will simply exit without waiting.)

Although old versions of the library had the nn::applet::CTR::ProcessHomeButtonIfPrepared function, it has the exact same behavior as this function. Use this function instead. The nn::applet::CTR::ProcessHomeButtonIfPrepared function may be removed someday.

Example

   // HOME Button transition check
   if ( applet::IsExpectedToProcessHomeButton() )
   {
       _save_my_data();

       // HOME Button transition process
       applet::ProcessHomeButton();

       // Wait
       applet::WaitForStarting();

       if ( applet::IsExpectedToCloseApplication() )
       {
             _close_application();
       }

       _recover_my_data();
   }

2010/12/10

Added information about the removal of ProcessHomeButtonIfPrepared.

2010/11/10

Initial version.