NdisMCmDispatchIncomingDropParty (NDIS 5.1) function
Note NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.
NdisMCmDispatchIncomingDropParty notifies a client that it should remove a particular party on a multipoint VC.
Syntax
VOID NdisMCmDispatchIncomingDropParty(
_In_ NDIS_STATUS DropStatus,
_In_ NDIS_HANDLE NdisPartyHandle,
_In_opt_ PVOID Buffer,
_In_ UINT Size
);
Parameters
DropStatus [in]
Indicates the reason this party is being dropped, usually NDIS_STATUS_SUCCESS if the remote party simply requested that its connection be closed.NdisPartyHandle [in]
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.Buffer [in, optional]
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. For example, this parameter is NULL on ATM networks.Size [in]
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 protocols, call NdisCmDispatchIncomingDropParty instead.
Requirements
Target platform |
Desktop |
Version |
|
Header |
Ndis.h (include Ndis.h) |
IRQL |
<= DISPATCH_LEVEL |
See also
NdisCmDispatchIncomingDropParty
NdisMCmDispatchIncomingCloseCall