GetIpAddrTable

The GetIpAddrTable function retrieves the interface–to–IP address mapping table.

DWORD GetIpAddrTable(
  PMIB_IPADDRTABLE pIpAddrTable,    // buffer for mapping table 
  PULONG pdwSize,                   // size of buffer 
  BOOL bOrder                       // sort the table 
);

Parameters

pIpAddrTable

Pointer to a buffer that, on successful return, contains the interface–to–IP address mapping table as a MIB_IPADDRTABLE structure.

pdwSize

Specifies the size of the buffer pointed to by the pIpAddrTable parameter. If the buffer is not large enough to hold the returned mapping table, the function sets this parameter equal to the required buffer size.

bOrder

Specifies whether the returned mapping table should be sorted in ascending order by IP address. If this parameter is TRUE, the table is sorted.

Return Values

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

  Windows NT/2000: Requires Windows NT 4.0 SP4 or later.
  Windows 95/98: Requires Windows 98.
  Header: Declared in Iphlpapi.h.
  Library: Use Iphlpapi.lib.

See Also

MIB_IPADDRTABLE