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>GetHomeButtonState</title>
8  </head>
9  <body>
10<h1><CODE>nn::applet::CTR::GetHomeButtonState</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/applet/CTR/HomeButtonState.html">AppletHomeButtonState</a> GetHomeButtonState(
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 the state. </div>
25<h2>Description</h2>
26    <div class="section">
27<p>Gets the state of the HOME Button.</p><p>The return value is either <CODE>nn::applet::CTR::HOME_BUTTON_NONE</CODE>, <CODE>nn::applet::CTR::HOME_BUTTON_SINGLE_PRESSED</CODE>, or <CODE>nn::applet::CTR::HOME_BUTTON_DOUBLE_PRESSED</CODE>.</p><p>For any state other than <CODE>nn::applet::CTR::HOME_BUTTON_NONE</CODE>, call the <a href="../../../nn/applet/CTR/ProcessHomeButton.html"><CODE>ProcessHomeButton</CODE></a> function after the application has run the necessary processing.</p><p>In general, use the <CODE>IsExpectedToProcessHomeMenu</CODE> function to determine whether HOME Button processing is required. That takes into account not only the importance of jumping to the HOME Menu because of a HOME Button press but also similar requests to jump to the HOME Menu from other applets.</p><p>Once you get a value other than <CODE>applet::HOME_BUTTON_NONE</CODE> from this function, you will continue to get the same value until you clear it (to <CODE>applet::HOME_BUTTON_NONE</CODE>).</p><!-- write here --></div>
28<h2>Revision History</h2>
29    <div class="section">
30      <dl class="history">
31        <dt>2010/11/10</dt>
32<dd>Initial version.<br />
33        </dd>
34      </dl>
35    </div>
36  <hr><p>CONFIDENTIAL</p></body>
37</html>