DOT11EXT_PRE_ASSOCIATE_COMPLETION callback function (wlanihv.h)

The IHV Extensions DLL calls the Dot11ExtPreAssociateCompletion function to asynchronously complete a pre-association operation initiated through a call to the Dot11ExtIhvPerformPreAssociate IHV Handler function.

Syntax

DOT11EXT_PRE_ASSOCIATE_COMPLETION Dot11extPreAssociateCompletion;

DWORD Dot11extPreAssociateCompletion(
  [in, optional] HANDLE hDot11SvcHandle,
  [in, optional] HANDLE hConnectSession,
  [in]           DWORD dwReasonCode,
  [in]           DWORD dwWin32Error
)
{...}

Parameters

[in, optional] hDot11SvcHandle

The handle used by the operating system to reference the wireless LAN (WLAN) adapter. This handle value was specified through a previous call to the Dot11ExtIhvInitAdapter IHV Handler function.

[in, optional] hConnectSession

The handle used by the operating system to reference the connection session with the basic service set (BSS) network. This handle value was specified through a previous call to the Dot11ExtIhvPerformPreAssociate IHV Handler function.

[in] dwReasonCode

A value that provides additional information for the completion status of the pre-association operation. The IHV Extensions DLL must set dwReasonCode to an L2_REASON_CODE_xxxx value, which are defined in L2cmn.h.

The IHV Extensions DLL returns the general completion status of the pre-association operation through the dwWin32Error parameter. Typically, the IHV Extensions DLL sets dwReasonCode to a value in the range from L2_REASON_CODE_IHV_BASE to (L2_REASON_CODE_IHV_BASE+ L2_REASON_CODE_GROUP_SIZE-1).

[in] dwWin32Error

The completion status of the pre-association operation as defined by an error code within Winerror.h. If the operation completes successfully, the IHV Extensions DLL must set dwWin32Error to ERROR_SUCCESS.

Return value

If the call succeeds, the function returns ERROR_SUCCESS. Otherwise, it returns an error code defined in Winerror.h.

Remarks

The IHV Extensions DLL must follow these guidelines when calling the Dot11ExtPreAssociateCompletion function.

• If the pre-association operation completed successfully, the IHV Extensions DLL must set dwReasonCode to one of the following:
  • L2_REASON_CODE_SUCCESS.
  • An IHV-defined value in the range from L2_REASON_CODE_IHV_BASE to (L2_REASON_CODE_IHV_BASE+ L2_REASON_CODE_GROUP_SIZE-1).
  In this situation, the IHV Extensions DLL must set dwWin32Error to ERROR_SUCCESS.
• If the pre-association operation completed with a failure, the IHV Extensions DLL must not set dwReasonCode to L2_REASON_CODE_SUCCESS. Instead, the DLL must set dwReasonCode to one of the following:
  • An appropriate L2_REASON_CODE_xxxx error value.
  • An IHV-defined value in the range from L2_REASON_CODE_IHV_BASE to (L2_REASON_CODE_IHV_BASE+ L2_REASON_CODE_GROUP_SIZE-1).
  In this situation, the IHV Extensions DLL must not set dwWin32Error to ERROR_SUCCESS. Instead, the DLL must set dwWin32Error to an appropriate error code defined in Winerror.h
• The IHV Extensions DLL must call Dot11ExtPreAssociateCompletion to cancel all pending pre-association operations whenever the Dot11ExtIhvAdapterReset or Dot11ExtIhvDeinitAdapter IHV Handler functions are called. In this situation, the DLL must set the dwWin32Error parameter to ERROR_CANCELLED.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Target Platform	Desktop
Header	wlanihv.h (include Wlanihv.h)

See also

Dot11ExtIhvAdapterReset

Dot11ExtIhvDeinitAdapter

Dot11ExtIhvInitAdapter

Native 802.11 IHV Handler Functions

Dot11ExtIhvPerformPreAssociate