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>EnableSleep</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/applet/Overview.html">applet</a>::<a href="../../../nn/applet/CTR/Overview.html">CTR</a>::EnableSleep</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14void EnableSleep(
15     bool isSleepCheck = nn::applet::CTR::SLEEP_IF_SHELL_CLOSED
16);
17</pre>
18    </div>
19<h2>Parameters</h2>
20    <div class="section">
21      <table class="arguments">
22        <thead>
23          <tr>
24            <td width="15" />
25<th>Name</th>
26<td>Description</td>
27          </tr>
28        </thead>
29        <tr>
30<td>in</td>
31<th>isSleepCheck</th>
32<td>If <CODE>true</CODE>, enters into Sleep Mode operations if the system is closed.</td>
33        </tr> </table>
34    </div>
35<h2>Return Values</h2>
36    <div class="section">
37None.
38               </div>
39<h2>Description</h2>
40    <div class="section">
41<p>Enables sleep mode.</p><!-- write here --><P>
42Once you use this function to enable Sleep Mode, the value that the application returns to the sleep query callback (as set by <a href="../../../nn/applet/CTR/SetSleepQueryCallback.html"><CODE>nn::applet::CTR::SetSleepQueryCallback</CODE></a>) is thereafter what this function returns as its return value.
43</P><P>
44If Sleep Mode is disabled, all responses are handled as <CODE>REPLY_REJECT</CODE>. The system will not transition to sleep if any application or applet returns <CODE>REPLY_REJECT</CODE> to a sleep query, disabling Sleep Mode as a result.
45</P><P>
46Using this function to enable sleep essentially may mean that the application can return <CODE>REPLY_ACCEPT</CODE> to any sleep queries. (Even after calling this function, the system will not transition to Sleep Mode if the application itself returns <CODE>REPLY_REJECT</CODE>.)
47</P><P>
48The behavior of this function up to this point is always the same, regardless of the argument values it is given.
49</P><P>
50Specify one of the following as the value for the <span class="argument">isSleepCheck</span> argument.
51</P><TABLE><THEAD><TR bgcolor="#ccccdd"><TH colspan="2">Value</TH><TH>Description</TH></TR></THEAD><TR><TD><CODE>true</CODE></TD><TD>applet::SLEEP_IF_SHELL_CLOSED</TD><TD>Checks once if the system is closed.</TD></TR><TR><TD><CODE>false</CODE></TD><TD>applet::NO_SHELL_CHECK</TD><TD>Does not check if the system is closed.</TD></TR></TABLE><P>
52If <CODE>true</CODE> or <CODE>applet::SLEEP::IF_SHELL_CLOSED</CODE>, the function will check once if the system is closed, and attempt to transition to sleep mode if it is closed.
53</P><P>
54If <CODE>false</CODE> or <CODE>applet::NO_SHELL_CHECK</CODE>, the function does not do this. The <a href="../../../nn/applet/CTR/Enable.html"><CODE>nn::applet::CTR::Enable</CODE></a> function calls <CODE>nn::applet::CTR::EnableSleep(applet::NO_SHELL_CHECK)</CODE> internally.
55</P><P>
56Specifying <CODE>true</CODE> or <CODE>false</CODE> for the <SPAN class="argument">isSleepCheck</SPAN> argument only affects whether the function checks once if the system is closed for this single call, and has no effect on any later calls.
57</P><P>
58After you call this function and enable sleep, it causes no problem to call this function again. You can also call this function for the purpose of checking whether the system is closed and then entering Sleep Mode.(The <a href="../../../nn/applet/CTR/Enable.html"><CODE>nn::applet::CTR::Enable</CODE></a> function code sample uses this function for exactly that purpose.)
59</P></div>
60<h2>Revision History</h2>
61    <div class="section">
62      <dl class="history">
63        <dt>2010/12/31</dt>
64<dd>Explained that it is no problem to call this function more than once.<br />
65        </dd>
66        <dt>2010/12/01</dt>
67<dd>Added operating details.
68        </dd>
69        <dt>2010/11/15</dt>
70<dd>Initial version.<br />
71        </dd>
72      </dl>
73    </div>
74  <hr><p>CONFIDENTIAL</p></body>
75</html>
76