MiniportCheckForHangEx (Compact 2013)

3/26/2014

NDIS calls a miniport driver's MiniportCheckForHangEx function to check the operational state of a network adapter.

Syntax

BOOLEAN MiniportCheckForHangEx (
    NDIS_HANDLE MiniportAdapterContext
);

Parameters

• MiniportAdapterContext
  A handle to a context area that the miniport driver allocated in its MiniportInitializeEx function. The miniport driver uses this context area to maintain state information for a miniport adapter.

Return Value

MiniportCheckForHangEx returns TRUE if the driver determines that a network adapter is not operating and NDIS should reset the device.

Remarks

A miniport driver specifies the MiniportCheckForHangEx entry point when it calls the NdisMRegisterMiniportDriver function.

MiniportCheckForHangEx is not required for intermediate drivers.

MiniportCheckForHangEx does nothing more than check the internal state of the network adapter and return TRUE if it detects that the network adapter is not operating correctly.

By default, NDIS calls MiniportCheckForHangEx approximately every two seconds. Because NDIS can call MiniportCheckForHangEx at IRQL <= DISPATCH_LEVEL, NDIS does not guarantee this time interval. To avoid unwanted delays at the user level, drivers should not dwell in MiniportCheckForHangEx.

If MiniportCheckForHangEx returns TRUE, NDIS calls the driver's MiniportResetEx function.

If a miniport driver does not complete an OID request within two successive calls to MiniportCheckForHangEx, NDIS can call the driver's MiniportResetEx function. However, to avoid unnecessary resets, the driver's MiniportInitializeEx function can extend the check-for-stopped-responding time-out interval when it calls the NdisMSetMiniportAttributes function.

MiniportCheckForHangEx can be preempted by an interrupt.

NDIS calls MiniportCheckForHangEx at IRQL <= DISPATCH_LEVEL.

See Also

Reference

NDIS Miniport Driver Functions
MiniportInitializeEx
MiniportResetEx
NdisMRegisterMiniportDriver
NdisMSetMiniportAttributes