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

  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

CreateIpForwardEntry, MIB_IPFORWARDROW, SetIpForwardEntry