The DeleteIPForwardEntry function deletes an IP forwarding entry from the IP routing table.

Syntax


WIN IONSAPI
DWORD
DeleteIPForwardEntry(
  _In_ PMIB_IPFORWARDROW pRoute
);

Parameters

Parameter Description
pRoute Pointer to a MIB_IPFORWARDROW structure that specifies the IP forwarding entry to delete. The structure must contain valid information to identify the route, including:
  • dwForwardProto
  • dwForwardIfIndex
  • dwForwardDest
  • dwForwardMask
  • dwForwardNextHop
Note that the dwForwardPolicyBasedNextHop member is not used by this function.

Return Value

If the function succeeds, the return value is NO_ERROR.

If the function fails, the return value is one of the following error codes.

NO_ERROR
ERROR_INVALID_PARAMETER
ERROR_NOT_FOUND
ERROR_CAN_NOT_COMPLETE
ERROR_ACCESS_DENIED

Remarks

On Windows Vista and later, the DeleteIPForwardEntry function is superseded by the DeleteIPForwardEntry2 function, which uses a more manageable MIB_IPFORWARDROW2 structure.

Note An application must have administrative privileges to call the DeleteIPForwardEntry function.

Requirements

Minimum supported client

 Windows 2000 Professional

Minimum supported server

 Windows 2000 Server

Header

 Iphlpapi.h

Library

 Iphlpapi.lib

DLL

 Iphlpapi.dll

See Also

Related Resources