DeleteIpForwardEntry
The DeleteIpForwardEntry function deletes an existing route in the local computer's IP routing table.
DWORD DeleteIpForwardEntry (
PMIB_IPFORWARDROW pRoute // pointer to route information );
Parameters
- pRoute
Pointer to a MIB_IPFORWARDROW structure. This structure specifies information that identifies the route to delete. The caller must specify values for the dwForwardIfIndex, dwForwardDest, dwForwardMask, dwForwardNextHop, and dwForwardPolicy members of the structure.
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.
Remarks
The dwForwardPolicy member of the MIB_IPFORWARDROW structure is currently unused. The caller should specify zero for this member.
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
CreateIpForwardEntry, FormatMessage, MIB_IPFORWARDROW, SetIpForwardEntry
Last updated on Tuesday, July 13, 2004
© 1992-2000 Microsoft Corporation. All rights reserved.