GetIpForwardTable

The GetIpForwardTable function retrieves the IP routing table.

DWORD GetIpForwardTable(
  PMIB_IPFORWARDTABLE pIpForwardTable,  // buffer for routing table
  PULONG pdwSize,                       // size of buffer
  BOOL bOrder                           // sort the table?
);

Parameters

pIpForwardTable

Pointer to a buffer that, on successful return, contains the IP routing table as a MIB_IPFORWARDTABLE structure.

pdwSize

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

bOrder

Specifies whether the returned table should be sorted. If this parameter is TRUE, the table is sorted in order of:

1. Destination address
2. Protocol that generated the route
3. Multipath routing policy
4. Next-hop address

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_IPFORWARDTABLE