NdisCmCloseAddressFamilyComplete function (ndis.h)

Article
04/18/2022

NdisCmCloseAddressFamilyComplete returns the final status of a client's request, for which the CM's ProtocolCmCloseAf function returned NDIS_STATUS_PENDING, to close the AF.

Syntax

void NdisCmCloseAddressFamilyComplete(
  [in] NDIS_STATUS Status,
  [in] NDIS_HANDLE NdisAfHandle
);

Parameters

[in] Status

The call manager sets this to NDIS_STATUS_SUCCESS.

[in] NdisAfHandle

Specifies the NDIS-supplied handle passed to the call manager's ProtocolCmOpenAf function when this client originally opened the address family.

Return value

None

Remarks

A stand-alone call manager must call NdisCmCloseAddressFamilyComplete 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 CM's call to NdisCmCloseAddressFamilyComplete causes a call to that client's ProtocolClCloseAfComplete function.

After a call to NdisCmCloseAddressFamilyComplete, the call manager cannot subsequently use the NdisAfHandle, which becomes invalid for the call manager as soon as this call occurs.

Only stand-alone call managers, which register themselves with NDIS as protocol drivers, can call NdisCmCloseAddressFamilyComplete. Connection-oriented miniport drivers that provide integrated call-management support must call NdisMCmCloseAddressFamilyComplete instead.

Requirements

Requirement	Value
Minimum supported client	Supported for NDIS 6.0 and NDIS 5.1 drivers (see NdisCmCloseAddressFamilyComplete (NDIS 5.1)) in Windows Vista. Supported for NDIS 5.1 drivers (see NdisCmCloseAddressFamilyComplete (NDIS 5.1)) in Windows XP.
Target Platform	Desktop
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	<= DISPATCH_LEVEL
DDI compliance rules	Irql_CallManager_Function(ndis)