PROTOCOL_OID_REQUEST_COMPLETE回调函数 (ndis.h)

项目
03/05/2024

ProtocolOidRequestComplete 函数完成协议驱动程序发起的 OID 请求的处理，NdisOidRequest 函数NDIS_STATUS_PENDING返回该请求。

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

语法

PROTOCOL_OID_REQUEST_COMPLETE ProtocolOidRequestComplete;

void ProtocolOidRequestComplete(
  [in] NDIS_HANDLE ProtocolBindingContext,
  [in] PNDIS_OID_REQUEST OidRequest,
  [in] NDIS_STATUS Status
)
{...}

参数

[in] ProtocolBindingContext

协议驱动程序分配的上下文区域的句柄，协议驱动程序在其中维护每个绑定的运行时状态。驱动程序在调用 NdisOpenAdapterEx 函数时提供了此句柄。

[in] OidRequest

指向协议驱动程序提供的 NDIS_OID_REQUEST 结构的指针，该结构以前传递给 NdisOidRequest 函数。

[in] Status

请求的最终状态。基础驱动程序或 NDIS 确定此最终状态。此参数确定 ProtocolOidRequestComplete 对 OidRequest 中的信息执行的操作。

返回值

无

备注

ProtocolOidRequestComplete 使用 Status 的输入值，如下所示：

如果 Status 为 NDIS_STATUS_SUCCESS，则 NDIS 或基础驱动程序已设置 NDIS_OID_REQUEST 结构的 BytesRead 或 BytesWritten 成员，以指定在设置操作中从 InformationBuffer 的缓冲区传输到 NIC 的协议驱动程序提供的信息量，或者在 InformationBuffer 上返回多少信息以响应查询操作。
如果协议驱动程序进行了查询， 则 ProtocolOidRequestComplete 可以通过协议驱动程序确定的任何方式使用 InformationBuffer 中返回的数据，具体取决于 Oid 成员的值。

例如，如果协议驱动程序最初启动 OID_GEN_MAXIMUM_SEND_PACKETS 查询， ProtocolOidRequestComplete 可能会在 ProtocolBindingContext 区域中设置状态变量，以限制驱动程序将为后续调用 NdisSendNetBufferLIsts 函数设置的未完成发送数。
如果 Status 为NDIS_STATUS_INVALID_LENGTH或NDIS_STATUS_BUFFER_TOO_SHORT，则 BytesNeeded 成员指定执行请求的操作所需的 InformationBufferLength 成员的特定于 OID 的值。
在这些情况下， ProtocolOidRequestComplete 可以为请求分配足够的缓冲区空间，使用所需的 InformationBufferLength 和相同的 Oid 设置另一个NDIS_OID_REQUEST结构，然后重试对 NdisOidRequest 函数的调用。

ProtocolOidRequestComplete 也可以重试某些其他NDIS_STATUS_ XXX 参数的请求，如 NdisOidRequest 函数的参考中所述。
如果 Status 是不可恢复错误的NDIS_STATUS_ XXX 值， 则 ProtocolOidRequestComplete 应释放为NDIS_OID_REQUEST结构分配的内存，并确定驱动程序是应关闭绑定，还是调整其特定于绑定的状态信息以处理对绑定的持续网络 I/O 操作。

对于全局查询和集，基础无连接微型端口驱动程序对 NdisMOidRequestComplete 函数的调用会导致 NDIS 调用 ProtocolOidRequestComplete 函数。 NDIS 将传递给 NdisMOidRequestComplete 的微型端口驱动程序确定的状态作为输入状态转发到 ProtocolOidRequestComplete。

对于特定于绑定的查询，NDIS 调用 ProtocolOidRequestComplete 函数本身。由于 NDIS 库维护所有微型端口驱动程序的绑定，因此 NDIS 只能返回有关基础驱动程序的特定于绑定的信息，这些驱动程序将其中等类型报告为系统为其提供筛选器库的驱动程序。对于协议驱动程序发起的特定于绑定的查询，NDIS 向其他微型端口驱动程序返回NDIS_STATUS_NOT_SUPPORTED。

有关系统定义的 OID 的详细信息，请参阅 NDIS OID。

可以在协议驱动程序有时间检查 NdisOidRequest 在 Status 中返回的状态代码之前调用 ProtocolOidRequestComplete。

NDIS 在 IRQL <= DISPATCH_LEVEL 调用 ProtocolOidRequestComplete。

示例

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

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

PROTOCOL_OID_REQUEST_COMPLETE MyOidRequestComplete;

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

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

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

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