DisableInterface

[This is preliminary documentation and subject to change.]

The DisableInterface function tells the routing protocol that an interface was administratively disabled.

DWORD DisableInterface(
  ULONG  InterfaceIndex  // index of the interface
);
 

Parameters

InterfaceIndex

Identifies the interface in the set of interfaces configured on the router.

Return Values

NO_ERROR

The interface was disabled successfully.

ERROR_CAN_NOT_COMPLETE

The attempt to disable the interface failed.

ERROR_INVALID_PARAMETER

The InterfaceIndex parameter is invalid (for example, no interface exists with that index, or the interface with that index is already disabled).

Remarks

If the interface is bound to a physical adapter, the protocol should deactivate the interface. That is, the protocol should refrain from any activity over this interface if the interface is bound to a physical adapter. Also, the protocol should not initiate demand dial connections for this interface.

QuickInfo

  Windows NT: Use version 5.0 and later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in routprot.h.
  Import Library: user-defined.

See Also

EnableInterface, DisableInterface Sample, UnbindInterface