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 interface–to–IP address mapping table.

Syntax 

DWORD GetIpAddrTable(
  PMIB_IPADDRTABLE 
pIpAddrTable, 
  PULONG 
pdwSize, 
  BOOL 
bOrder 
);

Parameters

pIpAddrTable

[out] Pointer to a buffer containing the interface–to–IP address mapping table as a MIB_IPADDRTABLEstructure.

pdwSize

[in, out] The size of the buffer indicated by the pIpAddrTableparameter. If the buffer is not large enough to hold the returned mapping table, the function sets this parameter to the required buffer size.

bOrder

[in] TRUE if the retrieved mapping table should be sorted in ascending order by IP address, and FALSE otherwise.

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