# WMStartScanCallback

## Definitions

  `#include <nitro/wm.h>`

      typedef struct WMStartScanCallback
      {
          u16         apiid;
          u16         errcode;
          u16         wlCmdID;
          u16         wlResult;
          u16         state;
          u8          macAddress[6];
          u16         channel;
          u16         linkLevel;
          u16         ssidLength;
          u16         ssid[16];
          u16         gameInfoLength;
          WMGameInfo  gameInfo;

      } WMStartScanCallback;

## Elements

apiid | This is the ID of the API that acts as the source for the callback generation. It is synonymous to the `WMApiid` enumerated type. Here, it is fixed as `WM_APIID_START_SCAN`.
errcode | This is the result of the asynchronous process. It is synonymous to the `WMErrCode` enumerated type.
wlCmdID | If errcode is `WM_ERRCODE_FAILED`, this function will store the ID of the command that was in error in the wireless firmware.
wlResult | If errcode is `WM_ERRCODE_FAILED`, this function will store the code was the source of the error in the wireless firmware.
state | If `errcode` is `WM_ERRCODE_SUCCESS`, the `WM Cause Code` generated by the callback is stored. There are two causes: `WM_STATECODE_PARENT_NOT_FOUND`, `WM_STATECODE_PARENT_FOUND`.
macAddress | If `state` is `WM_STATECODE_PARENT_FOUND`, the MAC address of the found parent will be stored.
channel | If `state` is `WM_STATECODE_PARENT_FOUND`, the channel of the found parent will be stored.
linkLevel | If the state is `WM_STATECODE_PARENT_FOUND`, the link strength at the time that the parent was found is stored.
ssidLength | If `state` is `WM_STATECODE_PARENT_FOUND`, the length of the found parent's verification ID will be stored in bytes. Length is sometimes 0 in the case of DS wireless play parents and stealth mode access points.
ssid | If `state` is `WM_STATECODE_PARENT_FOUND`, the verification ID of the found parent will be stored.
gameInfoLength | If `state` is `WM_STATECODE_PARENT_FOUND`, the length of the found parent's game specific information will be stored in bytes.
gameInfo | If `state` is `WM_STATECODE_PARENT_FOUND`, the game specific information of the found parent will be stored.

## Description

The structure that is passed to the callback function that is related to `WM_StartScan`.

## Revision History

03/10/2006 Added the fact that ssidLength is 0 for DS parent devices.
10/31/2005 Added element description of `macAddress` members.
10/05/2004 standardized MAC address in u8 type arrangement
08/30/2004 Added the member for the link strength at the time the parent was found.
08/10/2004 Corrected the callback generation causes.
08/02/2004 Standardized structure names.
07/29/2004 Initial version.

CONFIDENTIAL