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<title>ProcessHomeButton</title>
8  </head>
9  <body>
10<h1><CODE>nn::applet::CTR::ProcessHomeButton</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14bool ProcessHomeButton(
15     void
16);
17</pre>
18    </div>
19<h2>Arguments</h2>
20    <div class="section">
21<p>None.</p>
22    </div>
23<h2>Return Values</h2>
24<div class="section">Returns a value indicating whether it is necessary to wait. </div>
25<h2>Description</h2>
26    <div class="section">
27<p>Processes transitions to the HOME Menu.</p><!-- write here --><P>
28This function is used to jump to the HOME Menu when this is required by the <a href="../../../nn/applet/CTR/IsExpectedToProcessHomeButton.html"><CODE>nn::applet::CTR::IsExpectedToProcessHomeButton</CODE></a> function.
29</P><P>
30The return value indicates whether it is necessary to wait with the <a href="../../../nn/applet/CTR/WaitForStarting.html"><CODE>nn::applet::CTR::WaitForStarting</CODE></a> function after this function is called. If this is <CODE>true</CODE>, call the function. If this is <CODE>false</CODE>, you do not need to call the function. (Of course, even if you call the function it will simply exit without waiting.)
31</P><P>
32To ensure mutual exclusion with Sleep Mode, you must call <CODE><a href="../../../nn/applet/CTR/DisableSleep.html">nn::applet::CTR::DisableSleep</a>(true)</CODE> before calling this function. You must call <CODE><a href="../../../nn/applet/CTR/EnableSleep.html">nn::applet::CTR::EnableSleep</a>(true)</CODE> after waiting and determining to finish waiting. (Note that the above constraint is particular to the current version and may change in future.)
33</P><P>
34Example
35</P><PRE>
36   // HOME Button transition check
37   if ( applet::IsExpectedToProcessHomeButton() )
38   {
39       _save_my_data();
40       applet::DisableSleep(true);
41       // HOME Button transition process
42       <FONT color="red">applet::ProcessHomeButton();</FONT>
43       // Wait
44       applet::WaitForStarting();
45       if ( applet::IsExpectedToCloseApplication() )
46       {
47             _close_application();
48       }
49       applet::EnableSleep(true);
50       _recover_my_data();
51   }
52</PRE><BR /><P>
53Although old versions of the library had the <CODE>nn::applet::CTR::ProcessHomeButtonIfPrepared</CODE> function, it has the exact same behavior as this function. Use this function instead.
54</P></div>
55<h2>Revision History</h2>
56    <div class="section">
57      <dl class="history">
58        <dt>2011/01/24</dt>
59<dd>Added mention of the <CODE>DisableSleep</CODE> and <CODE>EnableSleep</CODE> functions.<br />
60        </dd>
61        <dt>2010/12/10</dt>
62<dd>Added information about the removal of <CODE>ProcessHomeButtonIfPrepared</CODE>.
63        </dd>
64        <dt>2010/11/10</dt>
65<dd>Initial version.<br />
66        </dd>
67      </dl>
68    </div>
69  <hr><p>CONFIDENTIAL</p></body>
70</html>
71