DoUpdateRoutes

[This is preliminary documentation and subject to change.]

The DoUpdateRoutes function requests the routing protocol to perform a routing information update over the specified interface to obtain static route information. (This process is called an autostatic route update.)

DWORD DoUpdateRoutes(
  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 update operation was successfully started on the interface. Check the routing protocol event queue for a completion event (see GetEventMessage).

ERROR_CAN_NOT_COMPLETE

The update operation could not be performed.

ERROR_INVALID_PARAMETER

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

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

DoUpdateRoutes Sample, DoUpdateServices, GetEventMessage