NdisMCmDispatchIncomingDropParty macro (ndis.h)

Article
02/22/2024

NdisMCmDispatchIncomingDropParty notifies a client that it should remove a particular party on a multipoint VC.

Syntax

void NdisMCmDispatchIncomingDropParty(
   _S_,
   _H_,
   _B_,
   _Z_
);

Parameters

_S_

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

_H_

Specifies the handle that identifies the party to be dropped from the multipoint VC, which must have other parties that are still connected. The MCM driver originally obtained this handle as an input parameter to its ProtocolCmAddParty function.

_B_

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.

_Z_

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

Return value

None

Remarks

In the course of normal network operations, an MCM driver calls NdisMCmDispatchIncomingDropParty with the CloseStatus set to NDIS_STATUS_SUCCESS because a remote client on a multipoint connection has called NdisClCloseCall.

However, an MCM driver also can call NdisMCmDispatchIncomingDropParty with a driver-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 NdisMCmDispatchIncomingDropParty causes NDIS to call the client's ProtocolClIncomingDropParty function.

If the NdisPartyHandle identifies the last remaining party on the given VC, the MCM driver calls NdisMCmDispatchIncomingCloseCall, rather than NdisMCmDispatchIncomingDropParty.

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

Requirements

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