NdisCloseAdapter function

Note NDIS 5. x has been deprecated and is superseded by NDIS 6. x. For new NDIS driver development, see Network Drivers Starting with Windows Vista. For information about porting NDIS 5. x drivers to NDIS 6. x, see Porting NDIS 5.x Drivers to NDIS 6.0.

NdisCloseAdapter releases the binding established and the resources allocated when the protocol called NdisOpenAdapter.

Syntax

VOID NdisCloseAdapter(
  _Out_ PNDIS_STATUS Status,
  _In_  NDIS_HANDLE  NdisBindingHandle
);

Parameters

  • Status [out]
    Pointer to a caller-supplied variable in which this function returns the status of the close operation, which can be one of the following values:

    • NDIS_STATUS_SUCCESS
      The binding was closed and all resources pertaining to that binding have been released.

    • NDIS_STATUS_PENDING
      A close-adapter request is being handled asynchronously, and the caller's ProtocolCloseAdapterComplete function will be called when the close operation is done.

  • NdisBindingHandle [in]
    Specifies the handle returned by NdisOpenAdapter that identifies the virtual adapter or NIC to be closed.

Return value

None

Remarks

A protocol driver typically calls NdisCloseAdapter from its ProtocolUnbindAdapter function. It can also call NdisCloseAdapter from its ProtocolBindAdapter function, for example, if it failed to set an OID value after calling NdisOpenAdapter to set up a binding.

As soon as a protocol calls NdisCloseAdapter, the handle at NdisBindingHandle should be considered invalid by the caller. It is a programming error to pass this handle in any subsequent call to an NdisXxx function.

Requirements

Target platform

Universal

Version

Not supported for NDIS 6.0 drivers in Windows Vista. Use NdisCloseAdapterEx instead. Supported for NDIS 5.1 drivers in Windows Vista and Windows XP.

Header

Ndis.h (include Ndis.h)

Library

Ndis.lib

IRQL

PASSIVE_LEVEL.

See also

NdisCompleteUnbindAdapter

NdisOpenAdapter

ProtocolCloseAdapterComplete

ProtocolUnbindAdapter

Send comments about this topic to Microsoft