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_GetAllowedChannel</title>
9<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css">
10</head>
11
12<body>
13
14<h1 align="left">WM_GetAllowedChannel&nbsp;<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
19u16 WM_GetAllowedChannel( void );
20</CODE></PRE></dd>
21</dl>
22
23<h2>Arguments</h2>
24<p>None.</p>
25
26<h2>Return Values</h2>
27<p>
28Returns the bitmask specifying the group of channels that are allowed to be used (between 1 and 14). Responds in order from lowest to highest bit (channel 1, channel 2, etc.). Then returns 0x8000 if WM is unaccessible (e.g., before initialization).
29</p>
30
31<H2>Description</H2>
32<P>
33Gets the channels that should be used in wireless communications This function is executable only when WM is in the IDLE state. For example, if <code>0x1041</code> is returned, channels <code>1</code>, <code>7</code>, and <code>13</code> will have the permission to be used. When you set the channel parameter in the <A href="WM_SetParentParameter.html"><code>WM_SetParentParameter</code></A> function to start communications as a parent, you must choose one of the channels that you obtain with this function. Use <code><a href="WM_MeasureChannel.html">WM_MeasureChannel</a></code> to check the signal strength of each channel. When scanning for the parent device as the child device with <A href="WM_StartScan.html"><code>WM_StartScan</code></A>, the parent device should be active on one of the channels that is obtained with this function. This will allow the narrowing down of the channels that should be scanned. However, this limit does not exist in infrastructure mode.
34</P>
35
36<h2>Note</h2>
37<p>
38When a value of 0 is returned to this function, there are no channels that should be used. In other words, it will display that <font color=red>wireless communications should not be performed.</font>Be aware that there is the possibility that a value of <code>0</code> will be returned if there was a console produced for a region where wireless communication is prohibited.
39</p>
40
41<h2>See Also</h2>
42<p><A href="WM_SetParentParameter.html"><code>WM_SetParentParameter</code></A>, <A href="WM_StartParent.html"><code>WM_StartParent</code></A>, <A href="WM_MeasureChannel.html"><code>WM_MeasureChannel</code></A>, <A href="WM_StartScan.html"><code>WM_StartScan</code></A></p>
43
44<H2>Revision History</H2>
45<P>
462004/10/27 Revised description of error values in &quot;Return Values&quot;.<br /> 2004/09/25 Added and revised descriptions.<br /> 2004/08/20 Initial version.
47</P>
48<hr><p>CONFIDENTIAL</p></body>
49</html>
50