SetIpForwardEntry2 function (netioapi.h)

The SetIpForwardEntry2 function sets the properties of an IP route entry on the local computer.

Syntax

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API SetIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Route
);

Parameters

[in] Route

A pointer to a MIB_IPFORWARD_ROW2 structure entry for an IP route entry. The DestinationPrefix member of the MIB_IPFORWARD_ROW2 must be set to a valid IP destination prefix, the NextHop member of the MIB_IPFORWARD_ROW2 must be set to a valid IP address family and IP address, and the InterfaceLuid or the InterfaceIndex member of the MIB_IPFORWARD_ROW2 must be specified.

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.

Return code Description
ERROR_ACCESS_DENIED
Access is denied. This error is returned under several conditions that include the following: the user lacks the required administrative privileges on the local computer or the application is not running in an enhanced 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 Route parameter, the DestinationPrefix member of the MIB_IPFORWARD_ROW2 pointed to by the Route parameter was not specified, the NextHop member of the MIB_IPFORWARD_ROW2 pointed to by the Route parameter was not specified, or both the InterfaceLuid or InterfaceIndex members of the MIB_IPFORWARD_ROW2 pointed to by the Route 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 Route parameter could not be found.
Other
Use FormatMessage to obtain the message string for the returned error.

Remarks

The SetIpForwardEntry2 function is defined on Windows Vista and later.

The SetIpForwardEntry2 function is used to set the properties for an existing IP route entry on a local computer.

The DestinationPrefix member in the MIB_IPFORWARD_ROW2 structure pointed to by the Route parameter must be initialized to a valid IP address prefix and family. The NextHop member in the MIB_IPFORWARD_ROW2 structure pointed to by the Route parameter must be initialized to a valid IP address and family. In addition, at least one of the following members in the MIB_IPFORWARD_ROW2 structure pointed to the Route parameter must be initialized to the interface: the InterfaceLuid or InterfaceIndex.

The fields are used in the order listed above. So if the InterfaceLuid is specified, then this member is used to determine the interface on which to add the unicast IP address. If no value was set for the InterfaceLuid member (the values of this member was set to zero), then the InterfaceIndex member is next used to determine the interface.

The route metric offset specified in the Metric member of the MIB_IPFORWARD_ROW2 structure pointed to by Route parameter represents only part of the complete route metric. The complete metric is a combination of this route metric offset added to the interface metric specified in the Metric member of the MIB_IPINTERFACE_ROW structure of the associated interface. An application can retrieve the interface metric by calling the GetIpInterfaceEntry function.

The Age and Origin members of the MIB_IPFORWARD_ROW2 structure pointed to by the Row are ignored when the SetIpForwardEntry2 function is called. These members are set by the network stack and cannot be changed using the SetIpForwardEntry2 function.

The SetIpForwardEntry2 function will fail if the DestinationPrefix and NextHop members of the MIB_IPFORWARD_ROW2 pointed to by the Route parameter do not match an IP route entry on the interface specified.

The SetIpForwardEntry2 function can only be called by a user logged on as a member of the Administrators group. If SetIpForwardEntry2 is called by a user that is not a member of the Administrators group, the function call will fail and ERROR_ACCESS_DENIED is returned.

The SetIpForwardEntry2 function can also fail because of user account control (UAC) on Windows Vista and later. If an application that contains this function is executed by a user logged on as a member of the Administrators group other than the built-in Administrator, this call will fail unless the application has been marked in the manifest file with a requestedExecutionLevel set to requireAdministrator. If the application lacks this manifest file, a user logged on as a member of the Administrators group other than the built-in Administrator must then be executing the application in an enhanced shell as the built-in Administrator (RunAs administrator) for this function to succeed.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header netioapi.h (include Iphlpapi.h)
Library Iphlpapi.lib
DLL Iphlpapi.dll

See also

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetBestRoute2

GetIpForwardEntry2

GetIpForwardTable2

GetIpInterfaceEntry

InitializeIpForwardEntry

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

MIB_IPINTERFACE_ROW

NotifyRouteChange2