GetAdapterOrderMap function (iphlpapi.h)

The GetAdapterOrderMap function obtains an adapter order map that indicates priority for interfaces on the local computer.

Syntax

IPHLPAPI_DLL_LINKAGE PIP_ADAPTER_ORDER_MAP GetAdapterOrderMap();

Return value

Returns an IP_ADAPTER_ORDER_MAP structure filled with adapter priority information. See the IP_ADAPTER_ORDER_MAP structure for more information.

Remarks

Interface indices appear in the order specified in the Adapters and Bindings dialog box in the Advanced Settings property sheet. This ordering is used as a tie breaker controlling the sequence in which interfaces are used on multihomed systems for situations including route selection, DNS name resolution, and other network related operations.

This function should not be called directly. Instead, use the IP_ADAPTER_INFO structure returned in a GetAdaptersInfo function call.

Note  The caller is responsible for calling the LocalFree function to free the array returned by GetAdapterOrderMap.
 

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header iphlpapi.h
Library Iphlpapi.lib
DLL Iphlpapi.dll

See also

GetAdaptersInfo

IP_ADAPTER_INFO

IP_ADAPTER_ORDER_MAP

LocalFree