NotifyRouteChange

The NotifyRouteChange function causes a notification to be sent to the caller whenever a change occurs in the IP routing table.

DWORD NotifyRouteChange(
  PHANDLE Handle,
  LPOVERLAPPED overlapped
);

Parameters

Handle

[out] Pointer to a HANDLE variable that receives a handle to use in asynchronous notification.

overlapped

[in] Pointer to an OVERLAPPED structure that will notify the caller of any changes in the routing table.

Return Values

If the function succeeds, the return value is NO_ERROR.

If the function fails, use FormatMessage to obtain the message string for the returned error.

Remarks

If the caller specifies NULL for the Handle and overlapped parameters, the call to NotifyRouteChange blocks until a routing table change occurs.

If the caller specifies a handle variable and an OVERLAPPED structure, the caller can use the returned handle with the OVERLAPPED structure to receive asynchronous notification of routing table changes. See GetQueuedCompletionStatus and the I/O Completion Ports overview for information about using the handle and OVERLAPPED structure to receive notifications.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Iphlpapi.h.
  Library: Use Iphlpapi.lib.

See Also

NotifyAddrChange, OVERLAPPED