PDO_UPDATE_ROUTES callback function (routprot.h)

Article
02/22/2024

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.)

Syntax

PDO_UPDATE_ROUTES PdoUpdateRoutes;

DWORD PdoUpdateRoutes(
  [in] ULONG InterfaceIndex
)
{...}

Parameters

[in] InterfaceIndex

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

Return value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

Value	Description
ERROR_CAN_NOT_COMPLETE	The update operation cannot be performed.
ERROR_INVALID_PARAMETER	The InterfaceIndex parameter is invalid (for example, no interface exists with that index).

Remarks

If the function returns NO_ERROR, the update operation started successfully on the interface. Check the routing protocol event queue for a completion event (see GetEventMessage).

Requirements

Requirement	Value
Minimum supported client	None supported
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	routprot.h