FILTER_CANCEL_OID_REQUEST回调函数 (ndis.h)

项目
08/07/2023

NDIS 调用筛选器驱动程序的 FilterCancelOidRequest 函数来取消 OID 请求。

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

语法

FILTER_CANCEL_OID_REQUEST FilterCancelOidRequest;

void FilterCancelOidRequest(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PVOID RequestId
)
{...}

参数

[in] FilterModuleContext

作为此请求目标的筛选器模块的上下文区域的句柄。筛选器驱动程序在 FilterAttach 函数中创建并初始化了此上下文区域。

[in] RequestId

请求的取消标识符。此标识符指定要取消的NDIS_OID_REQUEST 结构。

返回值

无

备注

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

当 NDIS 调用 FilterCancelOidRequest 时，筛选器驱动程序应尝试尽快调用 NdisFOidRequestComplete 函数。

请求参数在 OidRequest 的 NDIS_OID_REQUEST 结构中定义。

如果筛选器驱动程序未对 OID 请求进行排队，则驱动程序不需要提供 FilterCancelOidRequest 函数。如果筛选器驱动程序未指定 FilterCancelOidRequest 入口点，NDIS 将调用基础驱动程序的 cancel OID 请求函数。

当请求的发起方取消请求或超时成员指定的超时过期时，NDIS 调用 FilterCancelOidRequest 函数。

如果请求处理仍未在筛选器驱动程序中完成，驱动程序将调用状态设置为 NDIS_STATUS_REQUEST_ABORTED 的 NdisFOidRequestComplete 函数。

如果筛选器驱动程序将请求转发到基础驱动程序，但处理仍未完成，则筛选器驱动程序调用 NdisFCancelOidRequest 函数，并将 OidRequest 参数设置为它发送到基础驱动程序的值。

NDIS 在 IRQL <= DISPATCH_LEVEL 调用 FilterCancelOidRequest。

示例

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

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

FILTER_CANCEL_OID_REQUEST MyCancelOidRequest;

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

_Use_decl_annotations_
VOID
 MyCancelOidRequest(
    NDIS_HANDLE  FilterModuleContext,
    PVOID  RequestId
    )
  {...}

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

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