OID_WDI_TASK_ROAM (dot11wificxintf.h)

Important

This topic is part of the WiFiCx driver model. WiFiCx is the Wi-Fi driver model released in Windows 11. We recommend that you use WiFiCx to take advantage of the latest features. The previous Wi-Fi driver model WDI is in maintenance mode and will only receive high priority fixes.

OID_WDI_TASK_ROAM requests that the adapter tries to roam from the currently connected AP to a new one.

Object Abort capable Default priority (host driver policy) Normal execution time (seconds)
Port Yes. If aborted after disassociation, it must be followed by a dot11 reset. 4 10

The Microsoft component provides the list of preferred BSS entries that the adapter should consider for roaming.

When this command issued, if its currently associated, the adapter would need to disassociate from the currently connected AP and then roam to the new AP. In this case it would first indicate disassociation for the old AP, then indicate association result for the new AP and then complete the task.

It can also determine not to perform the roam and stay connected to the current AP. In this case it would only complete the task without any association or disassociation indications.

The scan and AP selection requirements for this task are same as for OID_WDI_TASK_CONNECT.

Task parameters

TLV Multiple TLV instances allowed Optional Description
WDI_TLV_CONNECT_PARAMETERS Connection parameters.
WDI_TLV_CONNECT_BSS_ENTRY X The preferred list of candidate connect BSS entries. The port should attempt to connect to these BSS entries until the list is exhausted, or the connection completed successfully. The port can reprioritize the entries if needed. If the adapter has set the Connect BSS Selection Override bit, then it can pick a BSS that is not in this list as long as it follows the Allowed/Disallowed list requirements.

Task completion indication

NDIS_STATUS_WDI_INDICATION_ROAM_COMPLETE

Unsolicited indications

NDIS_STATUS_WDI_INDICATION_ASSOCIATION_RESULT

NDIS_STATUS_WDI_INDICATION_DISASSOCIATION

NDIS_STATUS_WDI_INDICATION_FT_ASSOC_PARAMS_NEEDED

NDIS_STATUS_WDI_INDICATION_SAE_AUTH_PARAMS_NEEDED

Requirements

Requirement Value
Minimum supported client Windows 11
Minimum supported server Windows Server 2022
Header dot11wificxintf.h