NdisMCmNotifyCloseAddressFamily function

The NdisMCmNotifyCloseAddressFamily function notifies NDIS that a specified address family (AF) that is associated with a miniport call manager (MCM) should be closed and NDIS should notify any affected CoNDIS clients.

Syntax


NDIS_STATUS NdisMCmNotifyCloseAddressFamily(
  _In_  NDIS_HANDLE NdisAfHandle
);

Parameters

NdisAfHandle [in]

A handle that identifies the AF that NDIS should close. NDIS supplied this handle to the MCM's ProtocolCmOpenAf function.

Return value

NdisMCmNotifyCloseAddressFamily can return one of the following:

Return codeDescription
NDIS_STATUS_SUCCESS

NDIS successfully closed the address family.

NDIS_STATUS_PENDING

NDIS is handling this request asynchronously, and it will call the MCM'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

MCMs, which register as NDIS miniport drivers by calling the NdisMRegisterMiniportDriver function, can call the NdisMCmNotifyCloseAddressFamily function. Stand-alone call managers instead call the NdisCmNotifyCloseAddressFamily function.

To close an AF for a miniport adapter, the MCM should call NdisMCmNotifyCloseAddressFamily from its MiniportHaltEx function. NDIS subsequently calls the ProtocolClNotifyCloseAf function of the client that has the specified AF open.

If NdisMCmNotifyCloseAddressFamily returns NDIS_STATUS_PENDING, NDIS calls the MCM's ProtocolCmNotifyCloseAfComplete function after the client completes the AF close operation.

Requirements

Version

Supported in NDIS 6.0 and later.

Header

Ndis.h (include Ndis.h)

IRQL

PASSIVE_LEVEL

DDI compliance rules

Irql_MCM_Function

See also

NdisCmNotifyCloseAddressFamily
NdisMRegisterMiniportDriver
MiniportHaltEx
ProtocolClNotifyCloseAf
ProtocolCmNotifyCloseAfComplete
ProtocolCmOpenAf

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft