FILTER_CANCEL_SEND_NET_BUFFER_LISTS回调函数 (ndis.h)

项目
08/07/2023

NDIS 调用筛选器驱动程序的 FilterCancelSendNetBufferLists 函数来取消所有标有指定取消标识符的 NET_BUFFER_LIST 结构的传输。

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

语法

FILTER_CANCEL_SEND_NET_BUFFER_LISTS FilterCancelSendNetBufferLists;

void FilterCancelSendNetBufferLists(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PVOID CancelId
)
{...}

参数

[in] FilterModuleContext

筛选器驱动程序在其 FilterAttach 函数中分配的上下文区域的句柄。筛选器驱动程序使用此上下文区域来维护筛选器模块的状态信息。

[in] CancelId

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

返回值

无

备注

FilterCancelSendNetBufferLists 函数是可选的。如果筛选器驱动程序不筛选发送请求，则可以在调用时将此函数的入口点设置为 NULL NdisFRegisterFilterDriver 函数。

在发送之前将NET_BUFFER_LIST 结构排队的筛选器驱动程序应导出 FilterCancelSendNetBufferLists 函数。 FilterCancelSendNetBufferLists 函数取消指定NET_BUFFER_LIST结构的挂起传输。

当过度的 NDIS 驱动程序调用时 NdisCancelSendNetBufferLists 或 NdisFCancelSendNetBufferLists 函数，NDIS 调用绑定上筛选器模块的 FilterCancelSendNetBufferLists 函数。

筛选器驱动程序的 FilterCancelSendNetBufferLists 函数执行以下操作：

遍历指定筛选器模块的排队NET_BUFFER_LIST结构列表，并调用 NDIS_GET_NET_BUFFER_LIST_CANCEL_ID 宏以获取每个排队NET_BUFFER_LIST结构的取消标识符。筛选器驱动程序将NDIS_GET_NET_BUFFER_LIST_CANCEL_ID返回的取消 ID 与 NDIS 传递给 FilterCancelSendNetBufferLists 的取消 ID 进行比较。
从发送队列中删除 (取消链接) 其取消标识符与指定取消标识符匹配的所有 NET_BUFFER_LIST 结构。
调用所有未链接NET_BUFFER_LIST结构的 NdisFSendNetBufferListsComplete 函数以返回结构。筛选器驱动程序将NET_BUFFER_LIST结构的状态字段设置为NDIS_STATUS_SEND_ABORTED。
调用 NdisFCancelSendNetBufferLists 函数，将取消发送请求传递给基础驱动程序。

NDIS 在 IRQL <= DISPATCH_LEVEL 调用 FilterCancelSendNetBufferLists 。

示例

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

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

FILTER_CANCEL_SEND_NET_BUFFER_LISTS MyCancelSendNetBufferLists;

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

_Use_decl_annotations_
VOID
 MyCancelSendNetBufferLists(
    NDIS_HANDLE  FilterModuleContext,
    PVOID  CancelId
    )
  {...}

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

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