NdisMCmCloseAddressFamilyComplete macro (ndis.h)
NdisMCmCloseAddressFamilyComplete returns the final status of a client's request, for which the MCM driver returned NDIS_STATUS_PENDING, to close the AF.
Syntax
void NdisMCmCloseAddressFamilyComplete(
_S_,
_H_
);
Parameters
_S_
The caller sets this to NDIS_STATUS_SUCCESS.
_H_
Specifies the NDIS-supplied handle passed to the MCM driver's ProtocolCmOpenAf function when this client originally opened the address family.
Return value
None
Remarks
An MCM driver must call NdisMCmCloseAddressFamilyComplete if its ProtocolCmCloseAf function previously returned NDIS_STATUS_PENDING for the given NdisAfHandle . The client, which initiated the pended close-AF operation with a call to NdisClCloseAddressFamily, cannot release the resources it allocated to track communications on the AF until the MCM driver's call to NdisMCmCloseAddressFamilyComplete.
A call to NdisMCmCloseAddressFamilyComplete causes NDIS to call the client's ProtocolClCloseAfComplete function.
The MCM driver cannot subsequently use the NdisAfHandle, which is invalid for the MCM driver when NdisMCmCloseAddressFamilyComplete returns control.
Only connection-oriented miniport drivers that provide integrated call-management support can call NdisMCmCloseAddressFamilyComplete. Stand-alone call managers, which register themselves with NDIS as protocol drivers, call NdisCmCloseAddressFamilyComplete instead.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Supported for NDIS 6.0 and NDIS 5.1 drivers (see NdisMCmCloseAddressFamilyComplete (NDIS 5.1)) in Windows Vista. Supported for NDIS 5.1 drivers (see NdisMCmCloseAddressFamilyComplete (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) |