DOT11EXT_SET_DEFAULT_KEY 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 Dot11ExtSetDefaultKey function to add or delete a cipher key from the default key or per-station default key tables of the wireless LAN (WLAN) adapter. For more information about these key types, see 802.11 Cipher Key Types.

Syntax

DOT11EXT_SET_DEFAULT_KEY Dot11extSetDefaultKey;

DWORD Dot11extSetDefaultKey(
  [in, optional] HANDLE hDot11SvcHandle,
  [in]           PDOT11_CIPHER_DEFAULT_KEY_VALUE pKey,
  [in]           DOT11_DIRECTION dot11Direction
)
{...}

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] pKey

A pointer to a DOT11_CIPHER_DEFAULT_KEY_VALUE structure, which defines the cipher key.

[in] dot11Direction

A DOT11_DIRECTION value that specifies whether the key can be used only for received packets (DOT11_DIR_INBOUND) or both received and sent packets (DOT11_DIR_BOTH).

Note The IHV Extensions DLL must not pass a value of DOT11_DIR_OUTBOUND to this parameter.

Return value

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

Remarks

A call to the Dot11ExtSetDefaultKey function results in a set request of the OID_DOT11_CIPHER_DEFAULT_KEY object identifier to the WLAN adapter.

A default cipher key is defined by setting the MacAddr member of the DOT11_CIPHER_DEFAULT_KEY_VALUE structure to a value of 0x000000000000. A per-station default cipher key is defined by setting the MacAddr member to a valid unicast media access control (MAC) address.

A cipher key is deleted from the adapter's key tables if the bDelete member of the DOT11_CIPHER_DEFAULT_KEY_VALUE structure is set to TRUE.

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)