WMStartConnectCallback

Definitions

#include <nitro/wm.h>
typedef struct WMStartConnectCallback
{ 
    u16     apiid;
    u16     errcode;
    u16     wlCmdID;
    u16     wlResult;
    u16     state;
    u16     aid;
    u16     reason;
    u16     wlStatus;
    u8      macAddress[6];

} WMStartConnectCallback;

Elements

apiid This is the ID of the API that acts as the source for the callback generation. This argument is the same as the WMApiid enumerated type. Here, it is fixed as WM_APIID_START_CONNECT.
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 cause code generated by the callback is stored. There are five possible causes:

WM_STATECODE_CONNECT_START, WM_STATECODE_CONNECTED, WM_STATECODE_BEACON_LOST, WM_STATECODE_DISCONNECTED, WM_STATECODE_DISCONNECTED_FROM_MYSELF.
aid If state is WM_STATECODE_CONNECTED, the AID that is allocated by the parent will be stored.
reason Stores the code showing the reason for disconnection when the state is WM_STATECODE_DISCONNECTED or WM_STATECODE_DISCONNECTED_FROM_MYSELF.
This argument is used internally for debugging the library.
wlStatus If the errcode is WM_ERRCODE_FAILED, this stores the code that represents the status of the connection partner that caused the connection failure.
This member is used internally in the library for debugging.
macAddress If state is WM_STATECODE_CONNECTED or WM_STATECODE_DISCONNECTED_FROM_MYSELF, the MAC address of the parent will be stored.

Description

This structure is passed to the callback function related to WM_StartConnect.

Revision History

02/17/2006 Revised the description of the code returned in state.
10/31/2005 Added macAddress member.
09/05/2005 Added description of wlStatus member.
11/10/2004 Changed the description of the reason member.
08/02/2004 Unified structure names.
07/29/2004 Initial version.

CONFIDENTIAL