FILTER_PAUSE回调函数 (ndis.h)

项目
02/29/2024

NDIS 调用筛选器驱动程序的 FilterPause 函数来启动指定筛选器模块的暂停操作。

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

语法

FILTER_PAUSE FilterPause;

NDIS_STATUS FilterPause(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PNDIS_FILTER_PAUSE_PARAMETERS PauseParameters
)
{...}

参数

[in] FilterModuleContext

筛选器模块的上下文区域的句柄，筛选器驱动程序应暂停。筛选器驱动程序在 FilterAttach 函数中创建并初始化了此上下文区域。

[in] PauseParameters

指向的指针 NDIS_FILTER_PAUSE_PARAMETERS 结构，用于定义筛选器模块的暂停参数。

返回值

NDIS 驱动程序不能使暂停请求失败。筛选器驱动程序应将 NdisWriteEventLogEntry 函数与指定发生任何错误原因的参数一起调用。

返回代码	说明
NDIS_STATUS_SUCCESS	FilterPause 已成功暂停指定的筛选器模块。
NDIS_STATUS_PENDING	筛选器驱动程序将通过调用 NdisFPauseComplete 函数异步完成请求。

注解

FilterPause 是必需函数。当筛选器模块处于“正在运行”状态时，NDIS 可以调用 FilterPause。筛选器模块在 FilterPause 函数中开始执行时进入暂停状态。

当 NDIS 调用 FilterPause 时，筛选器驱动程序将执行以下操作：

必须调用 NdisFSendNetBufferListsComplete 函数，用于过度使用驱动程序创建的任何排队发送缓冲区。
必须调用 NdisFReturnNetBufferLists 函数适用于基础驱动程序创建的任何排队接收缓冲区。
必须等待 NDIS 返回驱动程序发起的所有未完成的发送请求 FilterSendNetBufferListsComplete 函数。
必须等待 NDIS 返回驱动程序源自的所有未完成的接收指示 FilterReturnNetBufferLists 函数。

筛选器驱动程序从 FilterPause 返回NDIS_STATUS_SUCCESS或调用 NdisFPauseComplete 函数后，暂停操作完成。筛选器模块处于 “已暂停” 状态。

在暂停或暂停状态中，筛选器驱动程序应继续处理 OID 请求或状态指示。驱动程序应拒绝对其的调用 FilterSendNetBufferLists 函数。驱动程序可以将调用传递给其 FilterReceiveNetBufferLists 函数。但是，驱动程序无法传递它创建的任何缓冲区。驱动程序不得发出任何接收指示或发送请求。

在 “暂停” 状态下，筛选器模块不得生成发送请求或接收指示。

NDIS 调用 FilterRestart 函数，为处于 “暂停” 状态的筛选器模块启动重启请求。

NDIS 在 IRQL = PASSIVE_LEVEL 调用 FilterPause 。

示例

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

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

FILTER_PAUSE MyPause;

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

_Use_decl_annotations_
NDIS_STATUS
 MyPause(
    NDIS_HANDLE  FilterModuleContext,
    PNDIS_FILTER_PAUSE_PARAMETERS  FilterPauseParameters
    )
  {...}

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

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