PROTOCOL_CL_CLOSE_AF_COMPLETE回调函数 (ndis.h)

项目
03/05/2024

面向连接的 NDIS 客户端使用 ProtocolClCloseAfComplete 函数。所有面向连接的 NDIS 客户端都必须具有 ProtocolClCloseAfComplete 函数才能完成它们使用 NdisCloseAddressFamily 启动的异步操作。

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

语法

PROTOCOL_CL_CLOSE_AF_COMPLETE ProtocolClCloseAfComplete;

void ProtocolClCloseAfComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolAfContext
)
{...}

参数

[in] Status

指定客户端启动的关闭地址系列请求的最终状态，可以是下列值之一：

NDIS_STATUS_SUCCESS

地址系列已关闭。表示客户端存储在其 ProtocolAfContext 区域中的开放地址系列的 NdisAfHandle 现在无效。

NDIS_STATUS_FAILURE

AF 具有关联的 VC () 和/或注册的 SAP () 客户端在尝试关闭 AF 之前必须释放，或者两次名为 NdisClCloseAddressFamily 的 客户端，因为 NDIS 发现 AF 状态标记为“正在关闭”。

[in] ProtocolAfContext

指定客户端提供给其每个 AF 上下文区域的句柄。客户端最初设置此上下文区域，并使用 NdisClOpenAddressFamilyEx 将此句柄传递给 NDIS。

返回值

无

备注

在确保其打开的地址系列上没有未完成的 VC 和/或注册的 SAP 后，客户端调用 NdisClClCloseAddressFamily 以删除自身、呼叫管理器和特定基础 NIC 之间的关联。 NDIS 为调用管理器调用 ProtocolCmCloseAf 函数，此客户端最初使用该函数作为异步操作打开地址系列。调用 NdisClClCloseAddressFamily 后，客户端应将 NdisAfHandle 视为无效。

因此，客户端必须具有 ProtocolCloseAfComplete 函数，NDIS 在异步关闭 AF 操作完成时调用该函数。如果输入状态 NDIS_STATUS_SUCCESS，则客户端可以释放其每 AF 上下文区域。

示例

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

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

PROTOCOL_CL_CLOSE_AF_COMPLETE MyClCloseAfComplete;

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

_Use_decl_annotations_
VOID
 MyClCloseAfComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolAfContext
    )
  {...}

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

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

要求

要求	值
最低受支持的客户端	支持 NDIS 6.0 和 NDIS 5.1 驱动程序 (请参阅 Windows Vista 中的 ProtocolCloseAfComplete (NDIS 5.1) ) 。 NDIS 5.1 驱动程序支持 (请参阅 Windows XP 中的 ProtocolCloseAfComplete (NDIS 5.1) ) 。
目标平台	Windows
标头	ndis.h (包括 Ndis.h)
IRQL	<= DISPATCH_LEVEL