1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<META http-equiv="Content-Type" content="text/html; charset=windows-1252"> 5<META name="GENERATOR" content="IBM WebSphere Studio Homepage Builder Version 8.0.0.0 for Windows"> 6<META http-equiv="Content-Style-Type" content="text/css"> 7<title>WMStartScanExCallback</title> 8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 9</head> 10<body> 11<h1 align="left">WMStartScanExCallback</h1> 12<h2>Definition</h2> 13<dl> 14 <dd> 15<CODE>#include <nitro/wm.h></CODE><BR> 16 <PRE><CODE>typedef struct WMStartScanExCallback 17{ 18 u16 apiid; 19 u16 errcode; 20 u16 wlCmdID; 21 u16 wlResult; 22 u16 state; 23 u16 channelList; 24 u16 bssDescCount; 25 <A href="WMBssDesc.html">WMBssDesc</A>* bssDesc[ 16 ]; 26 u16 linkLevel[ 16 ]; 27} WMStartScanExCallback;</CODE></PRE> 28 </dd> 29</dl><h2>Elements</h2> 30<TABLE border="1" width="100%"> 31 <TBODY> 32 <TR> 33 <TD width="200"><code>apiid</code></TD> 34 <TD width="800">ID of the API that acts as the source for the callback generation. It is equivalent to the <A href="WMApiid.html"><code>WMApiid</code></A> enumerated type. 35 Here, it is fixed as <code>WM_APIID_START_SCAN</code>. 36 </TD> 37 </TR> 38 <TR> 39 <TD width="200"><code>errcode</code></TD> 40 <TD width="800">Result of the asynchronous process. It is equivalent to the <A href="WMErrCode.html"><code>WMErrCode</code></A> enumerated type.</TD> 41 </TR> 42 <TR> 43 <TD width="200"><code>wlCmdID</code></TD> 44 <TD width="800">If <CODE>errcode</CODE> is <code>WM_ERRCODE_FAILED</code>, this function will store the ID of the command that was in error in the wireless firmware.</TD> 45 </TR> 46 <TR> 47 <TD width="200"><code>wlResult</code></TD> 48 <TD width="800">If <CODE>errcode</CODE> is <code>WM_ERRCODE_FAILED</code>, this function will store the code was the source of the error in the wireless firmware.</TD> 49 </TR> 50 <TR> 51 <TD width="200"><code>state</code></TD> 52 <TD width="800">If <CODE>errcode</CODE> is <CODE>WM_ERRCODE_SUCCESS</CODE>, the <A href="WMStateCode.html">WM Cause Code</A> generated by the callback is stored. There are two causes.<BR> 53 <code>WM_STATECODE_PARENT_NOT_FOUND</code>, <code>WM_STATECODE_PARENT_FOUND</code>. 54 </TD> 55 </TR> 56 <TR> 57 <TD width="200"><code>channelList</code></TD> 58 <TD width="800">Regardless of whether the parent device is found, the list of the scanned channels will be stored in a bit field format.</TD> 59 </TR> 60 <TR> 61 <TD width="200"><code>bssDescCount</code></TD> 62 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the number of parent devices discovered will be stored here.</TD> 63 </TR> 64 <TR> 65 <TD width="200"><code>bssDesc</code></TD> 66 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, a pointer array to the buffer where each item of parent device information is stored will be stored here. 67 <BR> Data lengths of each item of parent device information from the discovered parent devices sometimes differ, so to efficiently save the information in buffers of limited sizes, the discovered parent device information will be stored inside a buffer. 68 Therefore, be aware that this member is not a pointer to the top of the <A href="WMBssDesc.html"><code>WMBssDesc</code></A> type array; it is an array of pointers to the <A href="WMBssDesc.html"><code>WMBssDesc</code></A> type. 69 The size of the data entity for each of the parent device information items is shown in <A href="WMBssDesc.html"><code>WMBssDesc</code></A> length (half-word, or <code>u16</code> units).</TD> 70 </TR> 71 <TR> 72 <TD width="200"><code>linkLevel</code></TD> 73 <TD width="800">When <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, an array of the <A href="WMLinkLevel.html">link strengths</A> of each of the discovered parent devices is stored here.</TD> 74 </TR> 75 </TBODY> 76</TABLE> 77<H2>Description</H2> 78<P> 79This structure is passed to the callback function for the <A href="WM_StartScanEx.html"><code>WM_StartScanEx</code></A> function. 80</P> 81<H2>Revision History</H2> 82<P> 832005/03/02 Added a description about the <code>bssDesc</code> member.<BR> 2005/02/14 Initial version. 84</P> 85<hr><p>CONFIDENTIAL</p></body> 86</html> 87