DOT11EXT_SET_ETHERTYPE_HANDLING 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 IHV Extensions DLL calls the Dot11ExtSetEtherTypeHandling function to do the following:

Configure the wireless LAN (WLAN) adapter with a list of packet decryption exemptions. Each exemption is applied based on the IEEE EtherType of the received packet.
Register with the operating system for the EtherTypes of received packets that will be forwarded to IHV Extensions DLL through calls to the Dot11ExtIhvReceivePacket IHV Handler function.

Syntax

DOT11EXT_SET_ETHERTYPE_HANDLING Dot11extSetEthertypeHandling;

DWORD Dot11extSetEthertypeHandling(
  [in, optional] HANDLE hDot11SvcHandle,
  [in]           ULONG uMaxBackLog,
  [in]           ULONG uNumOfExemption,
  [in, optional] PDOT11_PRIVACY_EXEMPTION pExemption,
  [in]           ULONG uNumOfRegistration,
  [in, optional] USHORT *pusRegistration
)
{...}

Parameters

[in, optional] hDot11SvcHandle

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

[in] uMaxBackLog

The maximum number of received packets that the operating system queues if the IHV Extensions DLL has not returned from a call to the Dot11ExtIhvReceivePacket IHV Handler function. When uMaxBackLog is reached, the operating system discards the oldest packet in the queue.

[in] uNumOfExemption

The number of entries within the privacy exemptions array referenced by the pExemption parameter. A value of zero disables privacy exemptions on the WLAN adapter.

[in, optional] pExemption

A pointer to an array of privacy exemptions. Each entry in the array is formatted as a DOT11_PRIVACY_EXEMPTION structure.

[in] uNumOfRegistration

Number of entries within the IEEE EtherType registrations array referenced by the pusRegistration parameter. A value of zero disables the ability of the IHV Extensions DLL to receive any packets through calls to the Dot11ExtIhvReceivePacket IHV Handler function.

[in, optional] pusRegistration

A pointer to an array of IEEE EtherType registrations. Each entry has the EtherType value in big-endian format.

Return value

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

Remarks

When calling the Dot11ExtSetEtherTypeHandling function, the IHV Extensions DLL must follow these guidelines:

The IHV Extensions DLL can call Dot11ExtSetEtherTypeHandling from within the calls to either the Dot11ExtIhvInitAdapter or Dot11ExtIhvPerformPreAssociate IHV Handler functions.
The IHV Extensions DLL must not call Dot11ExtSetEtherTypeHandling after successfully completing the pre-association operation through a call to Dot11ExtPreAssociateCompletion.

The operating system defaults to an empty list of privacy exemptions and EtherType registrations prior to the call of the Dot11ExtIhvInitAdapter IHV Handler function.

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)