PROTOCOL_CL_CLOSE_AF_COMPLETE回调函数 (ndis.h)
面向连接的 NDIS 客户端使用 ProtocolCloseAfComplete 函数。 所有面向连接的 NDIS 客户端都必须具有 ProtocolCloseAfComplete 函数,才能完成使用 NdisCloseAddressFamily启动的异步作。
语法
PROTOCOL_CL_CLOSE_AF_COMPLETE ProtocolClCloseAfComplete;
void ProtocolClCloseAfComplete(
[in] NDIS_STATUS Status,
[in] NDIS_HANDLE ProtocolAfContext
)
{...}
参数
[in] Status
指定客户端发起的请求关闭地址系列的最终状态,可以是以下项之一:
NDIS_STATUS_SUCCESS
地址系列已关闭。 NdisAfHandle,表示客户端存储在其 ProtocolAfContext 区域中的开放地址系列现在无效。
NDIS_STATUS_FAILURE
AF 具有关联的 VC(s)和/或注册的 SAP(s),客户端在尝试关闭 AF 之前必须释放,或者名为 NdisCloseAddressFamily 的客户端 两次,因为 NDIS 发现 AF 状态被标记为“关闭”。
[in] ProtocolAfContext
指定客户端提供的每个 AF 上下文区域的句柄。 客户端最初设置此上下文区域,并通过 NdisClOpenAddressFamilyEx将此句柄传递给 NDIS。
返回值
没有
言论
确保其未完成的 VCS 和/或在其开放地址系列上注册了 SA 后,客户端会调用 NdisCloseAddressFamily,以删除自身、调用管理器和特定基础 NIC 之间的关联。 NDIS 为调用管理器调用 ProtocolCmCloseAf 函数,此客户端最初用于将地址系列作为异步作打开。 调用 NdisCloseAddressFamily后,客户端应考虑 NdisAfHandle 无效。
因此,客户端必须具有 ProtocolCloseAfComplete 函数,该函数在异步关闭 AF作完成后,NDIS 将调用该函数。 如果输入 状态 NDIS_STATUS_SUCCESS,则客户端可以释放其每 AF 上下文区域。
示例
若要定义 ProtocolCloseAfComplete 函数,必须先提供一个函数声明来标识要定义的函数的类型。 Windows 为驱动程序提供了一组函数类型。 使用函数类型声明函数有助于 驱动程序代码分析、静态驱动程序验证程序(SDV)和其他验证工具查找错误,这是为 Windows作系统编写驱动程序的要求。例如,若要定义名为“MyCloseAfComplete”的 ProtocolCloseAfComplete 函数,请使用 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的信息,请参阅 批注函数行为。
要求
要求 | 价值 |
---|---|
最低支持的客户端 | Windows Vista 中支持 NDIS 6.0 和 NDIS 5.1 驱动程序(请参阅 ProtocolCloseAfComplete (NDIS 5.1) 。 支持 NDIS 5.1 驱动程序(请参阅 Windows XP 中的 ProtocolCloseAfComplete (NDIS 5.1) 。 |
目标平台 | 窗户 |
标头 | ndis.h (包括 Ndis.h) |
IRQL | <= DISPATCH_LEVEL |