MINIPORT_CANCEL_SEND回调函数 (ndis.h)

项目
08/07/2023

NDIS 调用微型端口驱动程序的 MiniportCancelSend 函数来取消所有标有指定取消标识符的NET_BUFFER_LIST 结构的传输。

注意必须使用 MINIPORT_CANCEL_SEND 类型声明函数。有关详细信息，请参阅以下示例部分。

语法

MINIPORT_CANCEL_SEND MiniportCancelSend;

void MiniportCancelSend(
  [in] NDIS_HANDLE MiniportAdapterContext,
  [in] PVOID CancelId
)
{...}

参数

[in] MiniportAdapterContext

微型端口驱动程序在其 MiniportInitializeEx 函数中分配的上下文区域的句柄。微型端口驱动程序使用此上下文区域来维护有关适配器的状态信息。

[in] CancelId

取消标识符。此标识符指定要取消的NET_BUFFER_LIST 结构。

返回值

无

备注

排队发送 NET_BUFFER_LIST 结构的微型端口驱动程序和中间驱动程序导出 MiniportCancelSend 函数。 MiniportCancelSend 函数取消指定NET_BUFFER_LIST结构的挂起传输。

当过度的 NDIS 驱动程序调用时 NdisCancelSendNetBufferLists 函数，NDIS 调用绑定上相应较低级别驱动程序的 MiniportCancelSend 函数。仅当较低级别的驱动程序导出 MiniportCancelSend 函数时，NDIS 才会发出此调用。

微型端口驱动程序的 MiniportCancelSend 函数执行以下操作：

遍历指定适配器的排队NET_BUFFER_LIST结构列表，并调用 NDIS_GET_NET_BUFFER_LIST_CANCEL_ID 宏以获取每个排队NET_BUFFER_LIST结构的取消标识符。微型端口驱动程序将NDIS_GET_NET_BUFFER_LIST_CANCEL_ID返回的取消标识符与 NDIS 传递给 MiniportCancelSend 的取消标识符进行比较。
从发送队列中删除 (取消链接，) 其取消标识符与指定取消标识符匹配的所有NET_BUFFER_LIST结构。
调用所有未链接NET_BUFFER_LIST结构的 NdisMSendNetBufferListsComplete 函数返回结构。微型端口驱动程序将NET_BUFFER_LIST结构的状态字段设置为NDIS_STATUS_SEND_ABORTED。

中间驱动程序的 MiniportCancelSend 函数执行以下操作：

为微型端口驱动程序的 MiniportCancelSend 函数执行上述列表中的操作。
调用 NdisCancelSendNetBufferLists 函数，指定映射到 NDIS 在调用 MiniportCancelSend 中指定的适配器的绑定。

NDIS 在 IRQL 调用 MiniportCancelSend <= DISPATCH_LEVEL。

示例

若要定义 MiniportCancelSend 函数，必须先提供用于标识要定义的函数类型的函数声明。 Windows 为驱动程序提供了一组回调函数类型。使用函数类型声明函数可帮助驱动程序的代码分析、静态驱动程序验证程序 (SDV) 和其他验证工具查找错误，并且这是为 Windows 操作系统编写驱动程序的要求。

例如，若要定义名为“ MyCancelSend”的 MiniportCancelSend 函数，请使用 MINIPORT_CANCEL_SEND 类型，如以下代码示例所示：

MINIPORT_CANCEL_SEND MyCancelSend;

然后，按如下所示实现函数：

_Use_decl_annotations_
VOID
 MyCancelSend(
    NDIS_HANDLE  MiniportAdapterContext,
    PVOID  CancelId
    )
  {...}

MINIPORT_CANCEL_SEND函数类型在 Ndis.h 头文件中定义。若要在运行代码分析工具时更准确地识别错误，请务必将 Use_decl_annotations 注释添加到函数定义。 Use_decl_annotations注释可确保使用应用于头文件中MINIPORT_CANCEL_SEND函数类型的注释。有关函数声明要求的详细信息，请参阅使用 NDIS 驱动程序的函数角色类型声明函数。

有关 Use_decl_annotations的信息，请参阅批注函数行为。