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 index of the interface that has the best route to the specified IP address.

Syntax 

DWORD GetBestInterface(
  IPAddr 
dwDestAddr, 
  PDWORD 
pdwBestIfIndex 
);

Parameters

dwDestAddr

[in] The destination IP address for which to retrieve the interface that has the best route. For information about the IPAddrdata type, see Microsoft Win32 Simple Data Types in the Windows SDK.

pdwBestIfIndex

[out] Pointer to the index of the interface that has the best route to the address specified by the dwDestAddrparameter.

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