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:

  Destination address

  Protocol that generated the route

  Multipath routing policy

  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. For example, if the memory buffer is too small, this function returns ERROR_INSUFFICIENT_BUFFER, and you should then look at the dwSizeParameter for the required buffer size.

Requirements

Runs On	Versions	Defined in	Include	Link to
Windows CE OS	3.0 and later	Iphlpapi.h		Iphlpapi.lib

Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.

See Also

FormatMessage, MIB_IPFORWARDTABLE

 Last updated on Tuesday, July 13, 2004

© 1992-2000 Microsoft Corporation. All rights reserved.