1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<META http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.2.0 for Windows">
7<META http-equiv="Content-Style-Type" content="text/css">
8<title>WM_MeasureChannel</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">WM_MeasureChannel <img src="../../image/NTR.gif"><img src="../../image/TWL.gif"></H1>
15<h2>Syntax</h2>
16<dl>
17  <dd><PRE><CODE>#include &lt;nitro/wm.h&gt;
18
19<A href="WMErrCode.html">WMErrCode</A> WM_MeasureChannel(
20        <A href="WMCallbackFunc.html">WMCallbackFunc</A>  callback ,
21        u16             ccaMode ,
22        u16             edThreshold ,
23        u16             channel ,
24        u16             measureTime
25);
26</CODE></PRE></dd>
27</dl>
28
29<h2>Arguments</h2>
30<table border="1" width="100%">
31  <tbody>
32    <TR>
33      <TD width="200"><EM><STRONG><FONT face="Courier New">callback</FONT></STRONG></EM></TD>
34      <TD width="800">Designates the callback function to call when the asynchronous process completes. This callback is called from within the interrupt handler.</TD>
35    </TR>
36    <TR>
37      <TD width="200"><EM><STRONG><FONT face="Courier New">ccaMode</FONT></STRONG></EM></TD>
38      <TD width="800">Select the measure mode by using a value below (0-3).<br />
39      <UL><LI>0 : carrier sense mode. Measures only signals that are strong enough to affect Nintendo DS Wireless Communications.<br />
40          <LI>1 : ED threshold specification mode. Measures signals that exceed the value specified by <em><strong><code>edThreshold</code></strong></em>.<br />
41          <LI>2 : Measures signals meeting both carrier sense AND ED threshold strength requirements.<br />
42          <LI>3 : Measures signals meeting either carrier sense OR ED threshold strength requirements.
43      </UL></TD>
44    </TR>
45    <TR>
46      <TD width="200"><EM><STRONG><FONT face="Courier New">edThreshold</FONT></STRONG></EM></TD>
47      <TD width="800">If not in carrier sense mode, specifies the lower limit of signal strength to measure.
48      The value should be from 0 through 61 (-60 dBm to -80 dBm).</TD>
49    </TR>
50    <TR>
51      <TD width="200"><EM><STRONG><FONT face="Courier New">channel</FONT></STRONG></EM></TD>
52      <TD width="800">Specifies channel to measure. Use a value in the range of 1-14.</TD>
53    </TR>
54    <TR>
55      <TD width="200"><EM><STRONG><FONT face="Courier New">measureTime</FONT></STRONG></EM></TD>
56      <TD width="800">Specifies the measure period in units of 1 ms. The value should be 1 or higher.</TD>
57    </TR>
58   </tbody>
59</table>
60
61<h2>Return Values</h2>
62<p>Returns the results of the <CODE><A href="WMErrCode.html">WMErrCode</A></CODE> enumerated type process.</p>
63
64<H2>Description</H2>
65<P>
66This measures the signal usage rate of the specified channel The function is only executable when the WM is in the <code>IDLE</code> state. If the API return value is <code>WM_ERRCODE_OPERATING</code>, a callback occurs after the measurement of the signal usage rate is complete.
67</P>
68
69<H2>Revision History</H2>
70<P>
712005/06/08 Added statement about callbacks being called from the interrupt handler.<br>2005/03/02 Added to Description.<br>2004/10/22 Changed return value type.<br>2004/08/11 Initial version
72</P>
73<hr><p>CONFIDENTIAL</p></body>
74</html>
75