OID_WDI_ABORT_TASK (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_ABORT_TASK is a property that is sent down to cancel a specific pending task.
| Scope | Set serialized with task | Normal execution time (seconds) |
|---|---|---|
| Port | No | 1 |
This command follows property semantics. It should be treated as a signal, should be handled as quickly as possible, and should be completed independently of task completion. The IHV component must then attempt to complete the pending task as soon as possible.
Command parameters
| TLV | Multiple TLV instances allowed | Optional | Description |
|---|---|---|---|
| WDI_TLV_CANCEL_PARAMETERS | Information for the command that is being cancelled. |
Command result
Contains a status of NDIS_STATUS_SUCCESS. There is no additional payload.
Examples
Original input task command:
| Field | Subfield | Type | Value |
|---|---|---|---|
| NDIS_OID_REQUEST | Oid | NDIS_OID | OID(WDI_TASK_SCAN) |
| --- | InputBufferLength | UINT32 | 0x210 (example) |
| --- | InformationBuffer | PVOID | Pointer to memory block containing WDI_MESSAGE_HEADER + TLV payload |
| WDI_MESSAGE_HEADER | PortId | UINT16 | 0x0001 (example) |
| --- | Reserved | UINT16 | N/A |
| --- | WiFiStatus | NDIS_STATUS | N/A |
| --- | TransactionId | UINT32 | 0x1111 (example) |
| --- | IhvSpecificId | UINT32 | N/A |
| TLV Payload | TLV Payload | Various | Payload data |
Abort task input command (with message header):
| Field | Subfield | Type | Value |
|---|---|---|---|
| NDIS_OID_REQUEST | Oid | NDIS_OID | OID(WDI_ABORT_TASK) |
| --- | InputBufferLength | UINT32 | sizeof(WDI_MESSAGE_HEADER) + sizeof(WDI_TLV_CANCEL_PARAMETERS) |
| --- | InformationBuffer | PVOID | Pointer to memory block containing WDI_MESSAGE_HEADER + TLV payload |
| WDI_MESSAGE_HEADER | PortId | UINT16 | 0x0001 (example) |
| --- | Reserved | UINT16 | N/A |
| --- | WiFiStatus | NDIS_STATUS | N/A |
| --- | TransactionId | UINT32 | 0x2222 (example) |
| --- | IhvSpecificId | UINT32 | 0 |
| WDI_TLV_CANCEL_PARAMETERS | OriginalTaskOid | NDIS_OID | OID(WDI_TASK_SCAN) |
| --- | OriginalPortId | UINT16 | 0x0001 (example) |
| --- | OriginalTransactionId | UINT32 | 0x1111 (example) |
Abort task command result:
| Field | Subfield | Type | Value |
|---|---|---|---|
| NDIS_OID_REQUEST | Oid | NDIS_OID | OID(WDI_TASK_SCAN) |
| --- | OutputBufferLength | UINT32 | sizeof(WDI_MESSAGE_HEADER) |
| --- | InformationBuffer | PVOID | Pointer to memory block containing WDI_MESSAGE_HEADER |
| WDI_MESSAGE_HEADER | PortId | UINT16 | 0x0001 (example) |
| --- | Reserved | UINT16 | N/A |
| --- | WiFiStatus | NDIS_STATUS | NDIS_STATUS_SUCCESS |
| --- | TransactionId | UINT32 | 0x2222 (example) |
| --- | IhvSpecificId | UINT32 | N/A |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 11 |
| Minimum supported server | Windows Server 2022 |
| Header | dot11wificxintf.h |