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>StartSampling</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/hid/Overview.html">hid</a>::<a href="../../../../nn/hid/CTR/Overview.html">CTR</a>::<a href="../../../../nn/hid/CTR/ExtraPad/Overview.html">ExtraPad</a>::StartSampling</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> StartSampling(
15     <a href="../../../../nn_types/s32.html">s32</a> samplingThreadPriority,
16     <a href="../../../../nn_types/s32.html">s32</a> period
17);
18</pre>
19    </div>
20<h2>Parameters</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>samplingThreadPriority</th>
33<td>Sets the priority for the sampling thread. The higher the priority, the more stable you can expect the sampling to be.</td>
34        </tr>
35        <tr>
36<td>in</td>
37<th><CODE>period</CODE></th>
38<td>Sets the sampling period. Set a value in the range from 8 to 32 milliseconds. The shorter the sampling period, the higher the load.</td>
39        </tr> </table>
40    </div>
41<h2>Return Values</h2>
42<div class="section">Returns the function's result. Returns one of the <a href="../../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below.<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>Result::IsSuccess</CODE></th>
52<td>Process succeeded and sampling of the Nintendo 3DS Circle Pad Pro has started.</td>
53        </tr>
54        <tr>
55<th><CODE>MakeResultNoConnection</CODE></th>
56<td>The Nintendo 3DS Circle Pad Pro could not be found.</td>
57        </tr>
58        <tr>
59<th><CODE>MakeResultInvalidCombination</CODE></th>
60<td>Inappropriate argument.</td>
61        </tr>
62        <tr>
63<th><CODE>MakeResultNotInitialized</CODE></th>
64<td>Not initialized.</td>
65        </tr>
66      </table> </div>
67<h2>Description</h2>
68    <div class="section">
69<p>Starts sampling the Nintendo 3DS Circle Pad Pro. When this function succeeds, a thread for sampling is created internally using application resources.</p><p>It takes approximately 50 to 200 milliseconds for the Circle Pad Pro to be connected successfully or up to approximately 100 milliseconds for the connection to fail. If this function is called when sampling has already started, it will disconnect and then connect. The sampling thread is released by a call to the <a href="../../../../nn/hid/CTR/ExtraPad/StopSampling.html"><CODE>StopSampling</CODE></a> function.</p><!-- write here --></div>
70<h2>Revision History</h2>
71    <div class="section">
72      <dl class="history">
73        <dt>2011/10/06</dt>
74<dd>Initial version.<br />
75        </dd>
76      </dl>
77    </div>
78  <hr><p>CONFIDENTIAL</p></body>
79</html>
80