SetIpForwardEntry

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function modifies an existing route in the local computer's IP routing table. It can also add a new route to the routing table.

Syntax

DWORD SetIpForwardEntry(
  PMIB_IPFORWARDROW pRoute 
);

Parameters

• pRoute
  [in] Pointer to a MIB_IPFORWARDROW structure containing the new information for the existing route. The caller must specify values for the dwForwardIfIndex, dwForwardDest, dwForwardMask, dwForwardNextHop, dwForwardPolicy, and dwForwardProto members of the structure. For more information, see Remarks.

Return Value

Returns NO_ERROR if successful. If the function fails, it returns an error code. For a complete list of error codes, see Error Values or the SDK header file Winerror.h.

Remarks

The caller should not specify a routing protocol, such as PROTO_IP_OSPF, for the dwForwardProto member of the MIB_IPFORWARDROW structure. Routing protocol identifiers are used to identify route information received through the specified routing protocol only. For example, PROTO_IP_OSPF is used to identify route information received through the OSPF routing protocol only.

The dwForwardPolicy member of the MIB_IPFORWARDROW structure is currently unused. The caller should specify zero for this member.

Requirements

See Also

Reference

IP Helper Functions
CreateIpForwardEntry
DeleteIpForwardEntry
MIB_IPFORWARDROW