MINIPORT_CANCEL_DIRECT_OID_REQUEST回调函数 (ndis.h)

项目
08/07/2023

NDIS 调用微型端口驱动程序的 MiniportCancelDirectOidRequest 函数来取消直接 OID 请求。

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

语法

MINIPORT_CANCEL_DIRECT_OID_REQUEST MiniportCancelDirectOidRequest;

void MiniportCancelDirectOidRequest(
  [in] NDIS_HANDLE MiniportAdapterContext,
  [in] PVOID RequestId
)
{...}

参数

[in] MiniportAdapterContext

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

[in] RequestId

请求的取消标识符。此标识符指定在 NDIS_OID_REQUEST 结构的 RequestId 成员中与此值匹配的直接 OID 请求。

返回值

无

备注

MiniportCancelDirectOidRequest 是一个可选函数。如果微型端口驱动程序处理直接 OID 请求，则会注册此函数。驱动程序在调用时指定 MiniportCancelDirectOidRequest 入口点 NdisMRegisterMiniportDriver 函数。注册的微型端口驱动程序 MiniportDirectOidRequest 函数还必须注册 MiniportCancelDirectOidRequest。

当 NDIS 调用 MiniportCancelDirectOidRequest 时，微型端口驱动程序应尝试调用尽快使用 NdisMDirectOidRequestComplete 函数。

当请求的发起方取消请求时，NDIS 调用 MiniportCancelDirectOidRequest 。对于直接 OID 请求，如果超时过期，NDIS 不会调用 MiniportCancelDirectOidRequest 。 (在每个NDIS_OID_REQUEST结构的 Timeout 成员处指定超时。)

如果请求处理在微型端口驱动程序中仍未完成，驱动程序将调用状态设置为 NDIS_STATUS_REQUEST_ABORTED 的 NdisMDirectOidRequestComplete 函数。

如果请求处理在中间驱动程序中仍未完成，并且请求已传播到基础驱动程序，则中间驱动程序会调用 NdisCancelDirectOidRequest 函数，其 OidRequest 参数设置为它发送到基础驱动程序的值。

NDIS 在 IRQL <= DISPATCH_LEVEL 调用 MiniportCancelDirectOidRequest。

示例

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

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

MINIPORT_CANCEL_DIRECT_OID_REQUEST MyCancelDirectOidRequest;

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

_Use_decl_annotations_
VOID
 MyCancelDirectOidRequest(
    NDIS_HANDLE  MiniportAdapterContext,
    PVOID  RequestId
    )
  {...}

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

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