GetIpForwardTable
A version of this page is also available for
4/8/2010
This function retrieves the IP routing table.
Syntax
DWORD GetIpForwardTable(
PMIB_IPFORWARDTABLE pIpForwardTable,
PULONG pdwSize,
BOOL bOrder
);
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 Value
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
| Header | iphlpapi.h |
| Library | Iphlpapi.lib |
| Windows Embedded CE | Windows CE 3.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |