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>WMStartScanCallback</title> 8<LINK rel="stylesheet" href="../../css/nitro.css" type="text/css"> 9</head> 10<body> 11<h1 align="left">WMStartScanCallback</h1> 12<h2>Definition</h2> 13<dl> 14 <dd> 15<CODE>#include <nitro/wm.h></CODE><BR> 16 <PRE><CODE>typedef struct WMStartScanCallback 17{ 18 u16 apiid; 19 u16 errcode; 20 u16 wlCmdID; 21 u16 wlResult; 22 u16 state; 23 u8 macAddress[6]; 24 u16 channel; 25 u16 linkLevel; 26 u16 ssidLength; 27 u16 ssid[16]; 28 u16 gameInfoLength; 29 <A href="./WMGameInfo.html">WMGameInfo</A> gameInfo; 30} WMStartScanCallback;</CODE></PRE> 31 </dd> 32</dl><h2>Elements</h2> 33<TABLE border="1" width="100%"> 34 <TBODY> 35 <TR> 36 <TD width="200"><code>apiid</code></TD> 37 <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. 38 Here, it is fixed as <code>WM_APIID_START_SCAN</code>. 39 </TD> 40 </TR> 41 <TR> 42 <TD width="200"><code>errcode</code></TD> 43 <TD width="800">Result of the asynchronous process. It is equivalent to the <A href="WMErrCode.html"><code>WMErrCode</code></A> enumerated type.</TD> 44 </TR> 45 <TR> 46 <TD width="200"><code>wlCmdID</code></TD> 47 <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> 48 </TR> 49 <TR> 50 <TD width="200"><code>wlResult</code></TD> 51 <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> 52 </TR> 53 <TR> 54 <TD width="200"><code>state</code></TD> 55 <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> 56 <code>WM_STATECODE_PARENT_NOT_FOUND</code>, <code>WM_STATECODE_PARENT_FOUND</code>. 57 </TD> 58 </TR> 59 <TR> 60 <TD width="200"><CODE>macAddress</CODE></TD> 61 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the MAC address of the found parent will be stored.</TD> 62 </TR> 63 <TR> 64 <TD width="200"><CODE>channel</CODE></TD> 65 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the channel of the found parent will be stored.</TD> 66 </TR> 67 <TR> 68 <TD width="200"><CODE>linkLevel</CODE></TD> 69 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the link strength at the time that the parent was found is stored.</TD> 70 </TR> 71 <TR> 72 <TD width="200"><CODE>ssidLength</CODE></TD> 73 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the length of the found parent's verification ID will be stored in bytes. Length is sometimes 0 in the case of DS Multi-Card Play parents and stealth mode access points.</TD> 74 </TR> 75 <TR> 76 <TD width="200"><CODE>ssid</CODE></TD> 77 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the verification ID of the found parent will be stored.</TD> 78 </TR> 79 <TR> 80 <TD width="200"><CODE>gameInfoLength</CODE></TD> 81 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the length of the found parent's game specific information will be stored in bytes.</TD> 82 </TR> 83 <TR> 84 <TD width="200"><CODE>gameInfo</CODE></TD> 85 <TD width="800">If <code>state</code> is <code>WM_STATECODE_PARENT_FOUND</code>, the game-specific information of the found parent will be stored.</TD> 86 </TR> 87 </TBODY> 88</TABLE> 89<H2>Description</H2> 90<P> 91This structure is passed to the callback function for the <A href="WM_StartScan.html"><code>WM_StartScan</code></A> function. 92</P> 93<H2>Revision History</H2> 94<P> 952006/03/10 Added the fact that <code>ssidLength</code> is 0 for Nintendo DS parent devices.<BR> 2005/10/31 Added element description of <code>macAddress</code> members.<BR> 2004/10/05 Standardized MAC address in <code>u8</code> type arrangement.<BR> 2004/08/30 Added the member for the link strength at the time the parent was found.<BR> 2004/08/10 Corrected the callback generation causes.<BR> 2004/08/02 Standardized structure names.<BR> 2004/07/29 Initial version. 96</P> 97<hr><p>CONFIDENTIAL</p></body> 98</html> 99