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>StopScanning</title>
8  </head>
9  <body>
10<h1><CODE>nn::cec::CTR::CecControl::StopScanning</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14static <a href="../../../../nn/Result/Overview.html">nn::Result</a> StopScanning(
15     bool b_Immediate = false,
16     bool b_Async = false
17);
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>b_Immediate</th>
33<td>When <CODE>true</CODE> is set, the saving of the data being transmitted is also cancelled and stopped.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th>b_Async</th>
38<td>When <CODE>true</CODE> is set, returns immediately.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section"><a href="../../../../nn/Result/Overview.html"><CODE>nn::Result</CODE></a><br /> <br />
43      <table class="arguments">
44        <thead>
45          <tr>
46<th>Value</th>
47<td>Description</td>
48          </tr>
49        </thead>
50        <tr>
51<th><CODE>ResultSuccess</CODE></th>
52<td>Process succeeded.</td>
53        </tr>
54        <tr>
55<th><CODE>ResultStateBusy</CODE></th>
56<td>The halt process occurred but did not enter the halted state.</td>
57        </tr>
58        <tr>
59<th>A value other than the above.</th>
60<td>Failed.</td>
61        </tr>
62      </table> </div>
63<h2>Description</h2>
64    <div class="section">
65<p>Manually halts StreetPass (<a href="../../../../nn/cec/Overview.html">CEC</a>) operations.</p><p>If communications are in progress, the communications are interrupted and changed to stopped (IDLE) status.<br />Be aware that background communication might be interrupted.<br />To stop safely, first use <CODE>GetCecState</CODE> to confirm that the current state is not <CODE>DAEMON_STATE_COMMUNICATING</CODE> or <CODE>DAEMON_STATE_BUSY</CODE>, then stop communication. <br /><br />In order to access a <a href="../../../../nn/cec/CTR/MessageBox/Overview.html">message box</a>, communications must be in the stopped state. <br />Because the <a href="../../../../nn/cec/CTR/MessageBox/OpenMessageBox.html"><CODE>MessageBox::OpenMessageBox</CODE></a> function calls <CODE>StopScanning(b_Immediate = true)</CODE> you do not need to be aware of this issue when stopping, but by calling <CODE>StopScanning(b_Immediate = false)</CODE> beforehand, you can wait for communication to stop without interrupting any in-progress data saves.<br /><br />When b_Async is set to <CODE>true</CODE>, there is a possibility that it will not enter stop status after exiting this function, such as when this function is called multiple times and cancels are issued.<br />Be aware that even if <CODE>WriteMessage</CODE> or similar functions are called after this function is called, an error might be generated because it is in the BUSY state.</p><!-- write here --></div>
66<h2>Revision History</h2>
67    <div class="section">
68      <dl class="history">
69        <dt>2010/08/16</dt>
70<dd>Initial version.<br />
71        </dd>
72      </dl>
73    </div>
74  <hr><p>CONFIDENTIAL</p></body>
75</html>