NdisCmDispatchIncomingDropParty function (ndis.h)

Article
04/18/2022

NdisCmDispatchIncomingDropParty notifies a client that it should remove a particular party on a multipoint VC, usually because the call manager has received a request over the network to close an active multipoint connection.

Syntax

void NdisCmDispatchIncomingDropParty(
  [in]           NDIS_STATUS DropStatus,
  [in]           NDIS_HANDLE NdisPartyHandle,
  [in, optional] PVOID       Buffer,
  [in]           UINT        Size
);

Parameters

[in] DropStatus

Indicates the reason this party is being dropped, usually NDIS_STATUS_SUCCESS if the remote party simply requested that its connection be closed.

[in] NdisPartyHandle

Specifies the handle that identifies the party to be dropped from the multipoint VC, which must have other parties that are still connected.

[in, optional] Buffer

Pointer to a caller-allocated resident buffer containing additional protocol-specific data received from the remote party, if any. Depending on the underlying medium, this pointer can be NULL.

[in] Size

Specifies the size in bytes of the buffer, zero if Buffer is NULL.

Return value

None

Remarks

In the course of normal network operations, a stand-alone call manager's ProtocolCoReceiveNetBufferLists function calls NdisCmDispatchIncomingDropParty with the CloseStatus set to NDIS_STATUS_SUCCESS because a remote client on a multipoint connection has called NdisClCloseCall.

However, a call manager also can call NdisCmDispatchIncomingDropParty with a CM-determined CloseStatus at the behest of the network itself if abnormal network conditions occur, such as the failure of a switch on the path between the local client and one or more client(s) on an established multipoint connection.

A call to NdisCmDispatchIncomingDropParty causes NDIS to call the client's ProtocolClIncomingDropParty function.

If the NdisPartyHandle identifies the last remaining party on the given VC, the CM calls NdisCmDispatchIncomingCloseCall, rather than NdisCmDispatchIncomingDropParty.

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

Requirements

Requirement	Value
Minimum supported client	Supported for NDIS 6.0 and NDIS 5.1 drivers (see NdisCmDispatchIncomingDropParty (NDIS 5.1)) in Windows Vista. Supported for NDIS 5.1 drivers (see NdisCmDispatchIncomingDropParty (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)