DOT11EXTIHV_PERFORM_CAPABILITY_MATCH callback function (wlanihv.h)

Article
10/21/2021

Important The Native 802.11 Wireless LAN interface is deprecated in Windows 10 and later. Please use the WLAN Device Driver Interface (WDI) instead. For more information about WDI, see WLAN Universal Windows driver model.

The operating system calls the Dot11ExtIhvPerformCapabilityMatch function to request that the IHV Extensions DLL determine whether a detected basic service set (BSS) network matches the connectivity and security profile extensions defined by the IHV.

Syntax

DOT11EXTIHV_PERFORM_CAPABILITY_MATCH Dot11extihvPerformCapabilityMatch;

DWORD Dot11extihvPerformCapabilityMatch(
  [in, optional] HANDLE hIhvExtAdapter,
  [in, optional] PDOT11EXT_IHV_PROFILE_PARAMS pIhvProfileParams,
  [in]           PDOT11EXT_IHV_CONNECTIVITY_PROFILE pIhvConnProfile,
  [in]           PDOT11EXT_IHV_SECURITY_PROFILE pIhvSecProfile,
  [in, optional] PDOT11_BSS_LIST pConnectableBssid,
  [out]          PDWORD pdwReasonCode
)
{...}

Parameters

[in, optional] hIhvExtAdapter

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

[in, optional] pIhvProfileParams

A pointer to a DOT11EXT_IHV_PROFILE_PARAMS structure. This structure defines the attributes of the basic service set (BSS) network to which the profile extensions will be applied.

[in] pIhvConnProfile

A pointer to a DOT11EXT_IHV_CONNECTIVITY_PROFILE structure that contains connectivity settings for the IHV profile.

[in] pIhvSecProfile

A pointer to a DOT11EXT_IHV_SECURITY_PROFILE structure that contains security settings for the IHV profile.

[in, optional] pConnectableBssid

A pointer to a DOT11_BSS_LIST structure, which contains one or more 802.11 Beacon or Probe Response frames received from a BSS network. This list is derived from the results of the last scan operation performed by the WLAN adapter. For more information about the scan operation, see Native 802.11 Scan Operations.

Note For Windows Vista, the IHV Extensions DLL supports only infrastructure basic service set (BSS) networks.

[out] pdwReasonCode

A pointer to a DWORD value, which provides additional information for the return value of the Dot11ExtIhvPerformCapabilityMatch function. The IHV Extensions DLL must set * pdwReasonCode to an L2_REASON_CODE_xxxx value, which are defined in L2cmn.h.

Return value

If all of the entries in the list of 802.11 Beacon and Probe Response frames support the connectivity and security attributes defined in the profile fragments, the function returns ERROR_SUCCESS. Otherwise, it returns an error code defined in Winerror.h.

Remarks

After the WLAN adapter has completed a scan operation to detect the BSS networks within range, the operating system might call the Dot11ExtIhvPerformCapabilityMatch function to determine whether any of the detected BSS networks matches the connectivity or security profile extensions defined by the IHV.

When the Dot11ExtIhvPerformCapabilityMatch function is called, the IHV Extensions DLL must follow these guidelines.

If the IHV Extensions DLL finds at least one IEEE 802.11 Beacon or Probe Response frame that matches the profile fragments, it must set * pdwReasonCode 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 Dot11ExtIhvPerformCapabilityMatch function must return ERROR_SUCCESS.
If the IHV Extensions DLL does not find an IEEE 802.11 Beacon or Probe Response frame that matches the profile fragments, it must not set *pdwReasonCode to L2_REASON_CODE_SUCCESS. Instead, the DLL must set * pdwReasonCode 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 Dot11ExtIhvPerformCapabilityMatch function must not return ERROR_SUCCESS.

For more information about the Native 802.11 XML schema, refer to the Microsoft Windows SDK documentation.

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, Winclient.h, L2cmn.h)