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 creates a route in the local computer's IP routing table.

Syntax 

DWORD CreateIpForwardEntry( 
  PMIB_IPFORWARDROW 
pRoute
);

Parameters

pRoute

[in] Pointer to a MIB_IPFORWARDROWstructure that contains the information for the new route. The caller must specify values for all members of this structure. The caller must specify PROTO_IP_NETMGMT for the dwForwardProtomember of MIB_IPFORWARDROW.

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

To modify an existing route in the IP routing table, use the SetIpForwardEntryfunction.

The caller should not specify a routing protocol — for example, PROTO_IP_OSPF — for the dwForwardProtomember of the MIB_IPFORWARDROWstructure. Routing protocol identifiers are used only to identify route information received through the specified routing protocol. For example, PROTO_IP_OSPF is used only to identify route information received through the OSPF routing protocol.

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