NdisCmNotifyCloseAddressFamily function (ndis.h)

Article
04/18/2022

The NdisCmNotifyCloseAddressFamily function notifies NDIS that a call manager is unbinding from an underlying miniport adapter and that any associated CoNDIS clients should close the specified address family (AF).

Syntax

NDIS_STATUS NdisCmNotifyCloseAddressFamily(
  [in] NDIS_HANDLE NdisAfHandle
);

Parameters

[in] NdisAfHandle

An NDIS handle that identifies the AF that NDIS should close. NDIS supplied this handle to the call manager's ProtocolCmOpenAf function.

Return value

NdisCmNotifyCloseAddressFamily can return one of the following:

Return code	Description
NDIS_STATUS_SUCCESS	NDIS successfully closed the address family.
NDIS_STATUS_PENDING	NDIS is handling this request asynchronously, and it will call the call manager's ProtocolCmNotifyCloseAfComplete function when the close operation is complete.
NDIS_STATUS_XXX	NDIS failed the request for some NDIS or client driver-determined reason.

Remarks

Stand-alone CoNDIS call managers, which register as NDIS protocol drivers by calling the NdisRegisterProtocolDriver function, can call the NdisCmNotifyCloseAddressFamily function. Miniport call managers (MCMs) instead call the NdisMCmNotifyCloseAddressFamily function.

To close an AF for a binding, the stand-alone call manager should call NdisCmNotifyCloseAddressFamily from the ProtocolUnbindAdapterEx function. NDIS then calls the ProtocolClNotifyCloseAf function of the client that has the specified AF open.

If NdisCmNotifyCloseAddressFamily returns NDIS_STATUS_PENDING, NDIS calls the call manager's ProtocolCmNotifyCloseAfComplete function after the client completes the AF close operation.

Requirements

Requirement	Value
Minimum supported client	Supported in NDIS 6.0 and later.
Target Platform	Desktop
Header	ndis.h (include Ndis.h)
Library	Ndis.lib
IRQL	PASSIVE_LEVEL
DDI compliance rules	Irql_CallManager_Function(ndis)