PROTOCOL_CL_DROP_PARTY_COMPLETE 回调函数 (ndis.h)

项目
08/07/2023

ProtocolClDropPartyComplete 函数由设置多点连接的面向连接的 NDIS 客户端使用。此类客户端必须具有 ProtocolClDropPartyComplete 函数才能完成其启动的异步操作

NdisClDropParty。否则，此类协议驱动程序的已注册 ProtocolClDropPartyComplete 函数只需返回控制权。

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

语法

PROTOCOL_CL_DROP_PARTY_COMPLETE ProtocolClDropPartyComplete;

void ProtocolClDropPartyComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolPartyContext
)
{...}

参数

[in] Status

指定客户端启动的放置方操作的最终状态，可以是以下状态之一：

NDIS_STATUS_SUCCESS

该党已被放弃。表示此方的 NdisPartyHandle （客户端存储在其 ProtocolPartyContext 区域中）现在无效。

NDIS_STATUS_FAILURE

给定的一方是客户端多点 VC 上最后剩余的一方。因此，客户端应调用 NdisClCloseCall 来删除此参与方。

[in] ProtocolPartyContext

指定客户端每方上下文区域的句柄，客户端最初在调用 NdisClAddParty 或 NdisClMakeCall 时提供给 NDIS。

返回值

无

备注

调用 ProtocolClDropPartyComplete 表示调用管理器已完成客户端对 NdisClDropParty 的上一次调用发起的请求的处理。 ProtocolClDropPartyComplete 可以释放客户端分配的每方上下文区域，或准备在后续调用 NdisClAddParty 时重复使用。

如果客户端正在拆解其创建的多点 VC，ProtocolClDropPartyComplete 可以使用任何有效的 NdisPartyHandle 调用 NdisClDropParty，以调用客户端的活动多点 VC 上的剩余参与方之一。如果多点 VC 上只保留一个方，则客户端应将其 NdisPartyHandle 传递到 NdisClCloseCall 来删除该方。

示例

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

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

PROTOCOL_CL_DROP_PARTY_COMPLETE MyClDropPartyComplete;

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

_Use_decl_annotations_
VOID
 MyClDropPartyComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolPartyContext
    )
  {...}

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

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

要求

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