Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function retrieves the best route to the specified destination IP address.

Syntax 

DWORD GetBestRoute(
  DWORD 
dwDestAddr, 
  DWORD 
dwSourceAddr, 
  PMIB_IPFORWARDROW 
pBestRoute 
);

Parameters

dwDestAddr

[in] The destination IP address for which to obtain the best route.

dwSourceAddr

[in] A source IP address. This IP address corresponds to an interface on the local computer. If multiple best routes to the destination address exist, the function selects the route that uses this interface.

This parameter is optional. The caller may specify zero for this parameter.

pBestRoute

[out] Pointer to a MIB_IPFORWARDROWstructure containing the best route for the IP address specified by dwDestAddr.

Return Value

Returns NO_ERROR if successful. If the function fails, it returns an error code. For a complete list of error codes, see Error Valuesor the SDK header file Winerror.h.

Requirements

Header iphlpapi.h
Library Iphlpapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also