DeleteIpForwardEntry2 (Compact 2013)
3/26/2014
This function deletes an IP route entry on the local device.
Syntax
NETIOAPI_API DeleteIpForwardEntry2(
__in const MIB_IPFORWARD_ROW2* Row
);
Parameters
- Row
A pointer to a MIB_IPFORWARD_ROW2 structure entry for an IP route entry. On successful return, this entry will be deleted.
Return Value
Return code |
Description |
|---|---|
NO_ERROR |
The function succeeds. |
ERROR_ACCESS_DENIED |
Access is denied. This error is returned under several conditions that include the following: the user lacks the required administrative credentials on the local device or the application is not running in an improved shell as the built-in Administrator (RunAs administrator). |
ERROR_INVALID_PARAMETER |
An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the Row parameter, the DestinationPrefix member of the MIB_IPFORWARD_ROW2 pointed to by the Row parameter was not specified, the NextHop member of the MIB_IPFORWARD_ROW2 pointed to by the Row parameter was not specified, or both the InterfaceLuid or InterfaceIndex members of the MIB_IPFORWARD_ROW2 pointed to by the Row parameter were unspecified. |
ERROR_NOT_FOUND |
The specified interface could not be found. This error is returned if the network interface specified by the InterfaceLuid or InterfaceIndex member of the MIB_IPFORWARD_ROW2 pointed to by the Row parameter could not be found. |
ERROR_NOT_SUPPORTED |
The request is not supported. This error is returned if no IPv4 stack is located on the local device and an IPv4 address was specified in the Address member of the MIB_IPFORWARD_ROW2 pointed to by the Row parameter. This error is also returned if no IPv6 stack is located on the local device and an IPv6 address was specified in the Address member. |
Other |
Use FormatMessage to obtain the message string for the returned error. |
Remarks
The DeleteIpForwardEntry2 function is used to delete a MIB_IPFORWARD_ROW2 structure entry.
On input, the DestinationPrefix member in the MIB_IPFORWARD_ROW2 structure pointed to by the Row parameter must be initialized to a valid IPv4 or IPv6 address prefix and family. On input, the NextHop member in the MIB_IPFORWARD_ROW2 structure pointed to by the Row parameter must be initialized to a valid IPv4 or IPv6 address and family. In addition, at least one of the following members in the MIB_IPFORWARD_ROW2 structure pointed to the Row parameter must be initialized: the InterfaceLuid or InterfaceIndex. The fields are used in the order listed earlier. So if the InterfaceLuid is specified, this member is used to determine the interface. If no value was set for the InterfaceLuid member (the values of this member was set to zero), the InterfaceIndex member is next used to determine the interface.
On output when the call is successful, DeleteIpForwardEntry2 deletes the IP route entry.
The DeleteIpForwardEntry2 function will fail if the DestinationPrefix and NextHop members of the MIB_IPFORWARD_ROW2 pointed to by the Row parameter do not match an existing IP route entry on the interface specified in the InterfaceLuid or InterfaceIndex members.
The GetIpForwardTable2 function can be called to enumerate the IP route entries on a local device.
The DeleteIpForwardEntry2 function can only be called by a user logged on as a member of the Administrators group. If DeleteIpForwardEntry2 is called by a user who is not a member of the Administrators group, the function call will fail and ERROR_ACCESS_DENIED is returned.
See Also
Reference
IP Helper Functions
CreateIpForwardEntry2
GetBestRoute2
GetIpForwardEntry2
GetIpForwardTable2
InitializeIpForwardEntry
MIB_IPFORWARD_ROW2
MIB_IPFORWARD_TABLE2
NotifyRouteChange2
SetIpForwardEntry2