ProtocolClDropPartyComplete (NDIS 5.1) function

项目
06/19/2017

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 ProtocolClDropPartyComplete function is used by connection-oriented NDIS clients that set up multipoint connections. Such clients must have ProtocolClDropPartyComplete functions to complete the asynchronous operations that they initiate with NdisClDropParty. Otherwise, such a protocol driver's registered ProtocolClDropPartyComplete function can simply return control.

Syntax

VOID ProtocolClDropPartyComplete(
  _In_ NDIS_STATUS Status,
  _In_ NDIS_HANDLE ProtocolPartyContext
);

Parameters

Status [in]
Specifies the final status of the client-initiated drop-party operation, which can be one of the following:
- NDIS_STATUS_SUCCESS
  The party has been dropped. The NdisPartyHandle that represented this party, which the client stored in its ProtocolPartyContext area, is now invalid.
- NDIS_STATUS_FAILURE
  The given party was the last remaining on the client's multipoint VC. Therefore, the client should call NdisClCloseCall to drop this party.
ProtocolPartyContext [in]
Specifies the handle to the client's per-party context area, which the client originally supplied to NDIS either when it called NdisClAddParty or NdisClMakeCall.

Return value

None

Remarks

A call to ProtocolClDropPartyComplete indicates that the call manager has completed processing of the request initiated by the client's previous call to NdisClDropParty. ProtocolClDropPartyComplete can either release the client-allocated per-party context area or prepare it for reuse in a subsequent call to NdisClAddParty.

If the client is in the process of tearing down a multipoint VC that it created, ProtocolClDropPartyComplete can call NdisClDropParty with any valid NdisPartyHandle to one of the remaining parties on the client's active multipoint VC. If only one more party remains on its multipoint VC, the client should drop that party by passing its NdisPartyHandle to NdisClCloseCall.

Requirements

Target platform	Desktop
Version	See ProtocolClDropPartyComplete.
Header	Ndis.h (include Ndis.h)
IRQL	<= DISPATCH_LEVEL

通过