PROTOCOL_CL_ADD_PARTY_COMPLETE回调函数 (ndis.h)

对于设置多点连接的面向连接的 NDIS 客户端,需要 ProtocolClAddPartyComplete 函数。 此类客户端必须具有 ProtocolClAddPartyComplete 函数才能完成它们使用 NdisClAddParty 启动的异步操作。 否则,此类协议驱动程序的已注册 ProtocolClAddPartyComplete 函数只需返回控制权。

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

语法

PROTOCOL_CL_ADD_PARTY_COMPLETE ProtocolClAddPartyComplete;

void ProtocolClAddPartyComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE ProtocolPartyContext,
  [in] NDIS_HANDLE NdisPartyHandle,
  [in] PCO_CALL_PARAMETERS CallParameters
)
{...}

参数

[in] Status

指定客户端发起的添加方操作的最终状态,可以是下列操作之一:

NDIS_STATUS_SUCCESS

给定方已添加到客户端的活动多点 VC 上。

NDIS_STATUS_RESOURCES

NDIS 无法分配足够的资源来跟踪新方。

NDIS_STATUS_FAILURE

客户端将无效 的 NdisVcHandle 传递给 NdisClAddParty

NDIS_STATUS_XXX

调用管理器的 ProtocolCmAddParty 函数返回了一个 CM 确定的值,指示为何无法将参与方添加到 VC。

[in] ProtocolPartyContext

指定最初传递给 NdisClAddParty 的客户端提供的句柄。

[in] NdisPartyHandle

如果 状态 NDIS_STATUS_SUCCESS,则此 NDIS 提供的句柄表示与此方相关的调用管理器与客户端之间的关联。 否则,尝试添加方失败,客户端应将此参数视为无效句柄。

[in] CallParameters

指向 类型CO_CALL_PARAMETERS结构的指针,最初由客户端为其调用 NdisClAddParty 设置,但随后可能由调用管理器修改。

返回值

备注

ProtocolClAddPartyComplete 的调用指示客户端调用 NdisClAddParty 时启动的异步操作完成。 如果输入 状态 设置为除 NDIS_STATUS_SUCCESS 以外的任何内容, ProtocolClAddPartyComplete 可以在 ProtocolPartyContextCallParameters 上释放或重复使用客户端分配的缓冲区。

如果尝试添加一方成功, ProtocolClAddPartyComplete 应保存输入 NdisPartyHandle ,以便后续调用客户端 ProtocolPartyContext 区域中此方相关的 NDIS 库函数。 例如,客户端必须在后续调用 NdisClDropParty 中传递此句柄,除非它表示的远程方首先关闭其连接。

最初由客户端分配并初始化 CallParameters 的结构,该结构将此指针传递给
NdisClAddParty。 但是,调用管理器可能修改了客户端提供的值,以反映 CM 与网络协商的结果,或者在处理客户端的加载项请求时使用信号对等方协商的结果。 若要确定调用管理器是否进行了任何修改, ProtocolClAddPartyComplete 可以检查此结构的 Flags 成员是否设置了CALL_PARAMETERS_CHANGED。 如果是这样, ProtocolClAddPartyComplete 必须更新客户端在 ProtocolPartyContext 上为此调用维护的按方状态,除非它发现 CM 的修改是不能接受的。 特定信号协议确定客户端在这种情况下可以执行的操作。 通常,如果客户端发现 CM 修改的调用参数不能接受,则客户端会调用 NdisClDropParty

根据调用管理器的信号协议, CallParameters 上的流量参数对于任何特定多点连接的所有方来说都是相同的。 也就是说,由于此类调用管理器的客户端在最初使用 NdisClMakeCall 设置的多点连接上添加方,因此它只能提供每个方的目标地址,并将流量参数保留为每次调用 NdisClAddParty 时最初为多点 VC 设置的流量参数。

示例

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

例如,若要定义名为“ MyClAddPartyComplete”的 ProtocolClAddPartyComplete 函数,请使用 PROTOCOL_CL_ADD_PARTY_COMPLETE 类型,如以下代码示例所示:

PROTOCOL_CL_ADD_PARTY_COMPLETE MyClAddPartyComplete;

然后,按如下所示实现函数:

_Use_decl_annotations_
VOID
 MyClAddPartyComplete(
    NDIS_STATUS  Status,
    NDIS_HANDLE  ProtocolPartyContext,
    NDIS_HANDLE  NdisPartyHandle,
    PCO_CALL_PARAMETERS  CallParameters
    )
  {...}

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

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

要求

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

另请参阅

CO_CALL_PARAMETERS

NdisClAddParty

NdisClDropParty

NdisClMakeCall

NdisCmAddPartyComplete

NdisMCmAddPartyComplete

ProtocolClIncomingDropParty

ProtocolCmAddParty