ProtocolClIncomingDropParty (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.
The ProtocolClIncomingDropParty function is used by connection-oriented NDIS clients that set up multipoint connections. Such clients must have ProtocolClIncomingDropParty functions. Otherwise, such a protocol driver's registered ProtocolClIncomingDropParty function can simply return control.
Syntax
VOID ProtocolClIncomingDropParty(
_In_ NDIS_STATUS DropStatus,
_In_ NDIS_HANDLE ProtocolPartyContext,
_In_opt_ PVOID CloseData,
_In_opt_ UINT Size
);
Parameters
DropStatus [in]
Indicates the reason for the party to be dropped. Usually, this is NDIS_STATUS_SUCCESS if the party on the remote note initiated a close of its connection, but it could be any CM-determined status if the call manager initiated this drop-party operation due to network problems that it discovered.ProtocolPartyContext [in]
Specifies the handle to the client's per-party context area for the party to be dropped. The client originally supplied this handle to NDIS when it called NdisClAddParty or NdisClMakeCall.CloseData [in, optional]
Pointer to a buffer containing a protocol-specific close message, possibly one supplied by the remote client that the call manager received over the network, or this parameter can be NULL.When DropStatus is NDIS_STATUS_SUCCESS, this parameter is NULL if the underlying network medium does not support transfers of data when closing a connection. However, any particular call manager might define a structure to pass additional diagnostic information to its clients on drop-party operations caused by problems on the network.
Size [in, optional]
Specifies the length, in bytes, of the buffer at CloseData, zero if CloseData is NULL.
Return value
None
Remarks
A call to ProtocolClIncomingDropParty indicates that the one of the following has occurred:
The call manager has received a request over the network to close an established connection, identified by the NdisPartyHandle that the client stored in its per-party context area at ProtocolPartyContext.
The call manager has detected that network problems will prevent further data transfers on the established connection.
In either case, ProtocolClIncomingDropParty should carry out any protocol-determined operations for dropping the party from the client's multipoint VC. ProtocolClIncomingDropParty must call NdisClDropParty or, if this is the last remaining party on the client's multipoint VC, NdisClCloseCall.
ProtocolClIncomingDropParty should consider the NdisPartyHandle that the client obtained from NdisClAddParty or NdisClMakeCall invalid. ProtocolClIncomingDropParty can either release the client's per-party context area or prepare it for reuse in a subsequent call to NdisClAddParty.
Requirements
Target platform |
Desktop |
Version |
|
Header |
Ndis.h (include Ndis.h) |
IRQL |
<= DISPATCH_LEVEL |
See also
NdisCmDispatchIncomingDropParty
NdisMCmDispatchIncomingDropParty