CreateIpForwardEntry

A version of this page is also available for

Windows Embedded CE 6.0 R3

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_IPFORWARDROW structure 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 dwForwardProto member 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 Values or the SDK header file Winerror.h.

Remarks

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

The caller should not specify a routing protocol — for example, PROTO_IP_OSPF — for the dwForwardProto member of the MIB_IPFORWARDROW structure. 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 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
DeleteIpForwardEntry
MIB_IPFORWARDROW
SetIpForwardEntry