NdisMRemoveMiniport (Compact 2013)

3/26/2014

This function removes the specified miniport adapter that the miniport driver has determined is unrecoverable from the system.

Syntax

NDIS_STATUS NdisMRemoveMiniport(
  NDIS_HANDLE MiniportAdapterHandle
);

Parameters

• MiniportAdapterHandle
  [in] Specifies the handle to the initialized adapter that the miniport driver has determined is unrecoverable.

Return Value

The following table shows the return values for this function.

• NDIS_STATUS_SUCCESS
  The miniport adapter has been removed.

• NDIS_STATUS_FAILURE
  An attempt to remove the miniport adapter failed.

Remarks

If a miniport driver has determined that a particular miniport adapter has failed and is unrecoverable, the miniport driver can call NdisMRemoveMiniport to remove the adapter from the system. In this call, the miniport driver passes the handle to the adapter to remove.

A miniport driver can use a bundle of miniport adapters to balance the workload that each miniport adapter carries and to enable a secondary miniport adapter to take over packet transfers and information requests if the primary miniport adapter fails. For example, if the miniport driver's primary adapter fails, the miniport driver can call NdisMRemoveMiniport to remove the primary adapter from the system and from the miniport driver's bundle. The miniport driver can then call the NdisMPromoteMiniport function to promote a secondary adapter to the primary role.

The first miniport adapter that the miniport driver initialized is initially the primary miniport adapter. The primary miniport adapter handles all packet transfers and requests for information. A miniport driver can call the NdisMSetMiniportSecondary function during the subsequent initialization of several miniport adapters to set them all to secondary roles. That is, multiple secondary miniport adapters can exist in a bundle.

Requirements

See Also

Reference

NDIS Functions for Miniport Drivers
NdisMPromoteMiniport
NdisMSetMiniportSecondary