Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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_IPFORWARDROWstructure containing the new information for the existing route. The caller must specify values for the dwForwardIfIndex, dwForwardDest, dwForwardMask, dwForwardNextHop, dwForwardPolicy, and dwForwardProtomembers 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 Valuesor the SDK header file Winerror.h.

Remarks

The caller should not specify a routing protocol, such as PROTO_IP_OSPF, for the dwForwardProtomember of the MIB_IPFORWARDROWstructure. 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 dwForwardPolicymember of the MIB_IPFORWARDROWstructure is currently unused. The caller should specify zero for this member.

Requirements

Header iphlpapi.h
Library Iphlpapi.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also