GetBestRoute (Compact 2013)

  • Article

3/26/2014

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_IPFORWARDROW structure that contains the best route for the IP address specified by dwDestAddr.

Return Value

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.

Requirements

Header

iphlpapi.h

Library

Iphlpapi.lib

See Also

Reference

IP Helper Functions
GetBestInterface
MIB_IPFORWARDROW

Other Resources

IP Helper