GetIpForwardTable (Windows CE 5.0)

Send Feedback

This function retrieves the IP routing table.

DWORDGetIpForwardTable(PMIB_IPFORWARDTABLEpIpForwardTable, PULONGpdwSize, BOOLbOrder);

Parameters

  • pIpForwardTable
    [out] Pointer to a buffer containing the IP routing table as a MIB_IPFORWARDTABLE structure.
  • pdwSize
    [in, out] The size of the buffer indicated by the pIpForwardTable parameter. If the buffer is not large enough to hold the returned routing table, the function sets this parameter to the required buffer size.
  • bOrder
    [in] TRUE if the retrieved table should be sorted, and FALSE otherwise. The following list shows the order in which the table is sorted if this parameter is TRUE:
    • Destination address
    • Protocol that generated the route
    • Multipath routing policy
    • Next-hop address

Return Values

Returns NO_ERROR if successful. If the function fails, it returns an error code. For a complete list of error codes, see Error Values or the SDK header file Winerror.h.

Requirements

OS Versions: Windows CE 3.0 and later.
Header: Iphlpapi.h.
Link Library: Iphlpapi.lib.

See Also

IP Helper Functions | MIB_IPFORWARDTABLE

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.