FILTER_OID_REQUEST_COMPLETE回调函数 (ndis.h)

项目
08/07/2023

NDIS 调用 FilterOidRequestComplete 函数来完成在基础驱动程序中查询或设置信息的筛选器驱动程序请求。

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

语法

FILTER_OID_REQUEST_COMPLETE FilterOidRequestComplete;

void FilterOidRequestComplete(
  [in] NDIS_HANDLE FilterModuleContext,
  [in] PNDIS_OID_REQUEST OidRequest,
  [in] NDIS_STATUS Status
)
{...}

参数

[in] FilterModuleContext

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

[in] OidRequest

指向筛选器驱动程序先前传递给 NdisFOidRequest 函数的 NDIS_OID_REQUEST 结构的指针。

[in] Status

由基础驱动程序或 NDIS 设置的请求的最终状态。此参数确定 FilterOidRequestComplete 对 OidRequest 中的信息执行的操作。有关可能的状态值的列表，请参阅 NdisFOidRequest 的返回值。

返回值

无

备注

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

如果 NdisFOidRequest 函数返回NDIS_STATUS_PENDING，则 NDIS 必须调用 FilterOidRequestComplete 函数来完成 OID 请求。

如果筛选器驱动程序转发了它在 FilterOidRequest 函数中收到的请求， 则 FilterOidRequestComplete 应通过调用 NdisFOidRequestComplete 函数向上传递驱动程序堆栈的完成状态。筛选器驱动程序必须调用 NdisFreeCloneOidRequest，以释放NDIS_OID_REQUEST结构，然后才能调用 NdisFOidRequestComplete。

筛选器驱动程序应跟踪它发出的请求，并确保当 NDIS 为此类请求调用 FilterOidRequestComplete 时，它不会调用 NdisFOidRequestComplete 。

NDIS 在 IRQL <= DISPATCH_LEVEL 调用 FilterOidRequestComplete。

示例

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

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

FILTER_OID_REQUEST_COMPLETE MyOidRequestComplete;

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

_Use_decl_annotations_
NDIS_STATUS
 MyOidRequestComplete(
    NDIS_HANDLE  FilterModuleContext,
    PNDIS_OID_REQUEST  OidRequest,
    NDIS_STATUS  Status
    )
  {...}

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

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