NdisCmDropPartyComplete function (ndis.h)

Article
04/18/2022

NdisCmDropPartyComplete returns the final status of a client's request, for which the call manager previously returned NDIS_STATUS_PENDING, to remove a party from a multipoint VC.

Syntax

void NdisCmDropPartyComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE NdisPartyHandle
);

Parameters

[in] Status

Specifies the final status of the requested operation, either NDIS_STATUS_SUCCESS or any CM-determined NDIS_STATUS_ XXX except NDIS_STATUS_PENDING.

[in] NdisPartyHandle

Specifies the handle to the party that the client requested to be dropped. The call manager obtained this handle from the state area designated by CallMgrPartyContext that was passed as an input parameter to its ProtocolCmDropParty function.

Return value

None

Remarks

A stand-alone call manager must call NdisCmDropPartyComplete if its ProtocolCmDropParty function previously returned NDIS_STATUS_PENDING for the given NdisPartyHandle . Neither NDIS nor the client, which initiated the pended drop-party operation with a call to NdisClDropParty, can release the resources they allocated to maintain per-party state until the CM's call to NdisCmDropPartyComplete causes a call to that client's ProtocolClDropPartyComplete function.

If it passes NDIS_STATUS_SUCCESS for the Status, the call manager should consider the NdisPartyHandle invalid as soon as it calls NdisCmDropPartyComplete. The CM can release (or reinitialize for reuse) any resources that it allocated to maintain state for this party when NdisCmDropPartyComplete returns control.

Only stand-alone call managers, which register themselves with NDIS as protocol drivers, can call NdisCmDropPartyComplete. Connection-oriented miniport drivers that provide integrated call-management support call NdisMCmDropPartyComplete instead.

Requirements

Requirement	Value
Minimum supported client	Supported for NDIS 6.0 and NDIS 5.1 drivers (see NdisCmDropPartyComplete (NDIS 5.1)) in Windows Vista. Supported for NDIS 5.1 drivers (see NdisCmDropPartyComplete (NDIS 5.1)) in Windows XP.
Target Platform	Desktop
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	<= DISPATCH_LEVEL
DDI compliance rules	Irql_CallManager_Function(ndis)