NdisMCmAddPartyComplete macro (ndis.h)

NdisMCmAddPartyComplete returns the final status of a client's request, for which the MCM driver previously returned NDIS_STATUS_PENDING, to add a party on an established multipoint VC.

Syntax

void NdisMCmAddPartyComplete(
   _S_,
   _H_,
   _C_,
   _P_
);

Parameters

_S_

Specifies the final status of the MCM driver's add-party operation, either NDIS_STATUS_SUCCESS or any NDIS_STATUS_XXXexcept NDIS_STATUS_PENDING.

_H_

Specifies the handle identifying the party. The MCM driver obtained this handle as input parameter to its ProtocolCmAddParty function.

_C_

Specifies the handle to a caller-allocated resident context area in which the MCM driver will maintain party-specific state information if the add-party operation succeeded. Otherwise, this parameter can be NULL because it is ignored by NDIS if Status is anything other than NDIS_STATUS_SUCCESS.

_P_

Pointer to a structure of type CO_CALL_PARAMETERS that contains the call parameters, originally supplied by the client, for the party to be added.

Return value

None

Remarks

If an MCM driver's ProtocolCmAddParty function returns NDIS_STATUS_PENDING, the driver must call NdisMCmAddPartyComplete subsequently to notify the client and NDIS that its attempt to add a party on the multipoint VC has completed, whether successfully or with an MCM driver-determined error status.

The underlying network medium determines whether a client can specify per-party traffic parameters on a multipoint VC.

If the underlying network medium does not support per-party traffic parameters on multipoint VCs, an MCM driver can do one of the following whenever a client attempts to add a party with a specification at CallParameters that does not match the already established traffic parameters for that VC:

• Reset the traffic parameters to those already established for the multipoint VC when it successfully adds the party on that VC.
• Change the traffic parameters for every party already on the VC when it successfully adds the new party.
• Reject the request to add a new party. (This alternative implicitly forces clients to set up their traffic parameters for a multipoint VC with NdisClMakeCall and to specify the same traffic parameters at each subsequent call to NdisClAddParty for the given multipoint VC.)

A call to NdisMCmAddPartyComplete causes NDIS to call the client's ProtocolClAddPartyComplete function.

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

Requirements

See also

CO_CALL_PARAMETERS

NdisClAddParty

NdisCmAddPartyComplete

NdisMCmDropPartyComplete

ProtocolClAddPartyComplete

ProtocolCmAddParty