Skip to content

Latest commit

 

History

History
115 lines (74 loc) · 4.38 KB

nf-netioapi-initializeipforwardentry.md

File metadata and controls

115 lines (74 loc) · 4.38 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:netioapi.InitializeIpForwardEntry
InitializeIpForwardEntry function (netioapi.h)
Initializes a MIB_IPFORWARD_ROW2 structure with default values for an IP route entry on the local computer.
InitializeIpForwardEntry
InitializeIpForwardEntry function [IP Helper]
iphlp.initializeipforwardentry
netioapi/InitializeIpForwardEntry
iphlp\initializeipforwardentry.htm
IpHlp
1968c4e5-4b28-4387-a918-3326bc80bb3e
12/05/2018
InitializeIpForwardEntry, InitializeIpForwardEntry function [IP Helper], iphlp.initializeipforwardentry, netioapi/InitializeIpForwardEntry
netioapi.h
Iphlpapi.h
Windows
Windows Vista [desktop apps only]
Windows Server 2008 [desktop apps only]
Iphlpapi.lib
Iphlpapi.dll
Windows
19H1
InitializeIpForwardEntry
netioapi/InitializeIpForwardEntry
c++
APIRef
kbSyntax
DllExport
Iphlpapi.dll
InitializeIpForwardEntry

InitializeIpForwardEntry function

-description

The InitializeIpForwardEntry function initializes a MIB_IPFORWARD_ROW2 structure with default values for an IP route entry on the local computer.

-parameters

-param Row [out]

On entry, a pointer to a MIB_IPFORWARD_ROW2 structure entry for an IP route entry. On return, the MIB_IPFORWARD_ROW2 structure pointed to by this parameter is initialized with default values for an IP route entry.

-returns

This function does not return a value.

-remarks

The InitializeIpForwardEntry function is defined on Windows Vista and later.

The InitializeIpForwardEntry function must be used to initialize the members of a MIB_IPFORWARD_ROW2 structure entry with default values for an IP route entry for later use with the CreateIpForwardEntry2 function.

On input, InitializeIpForwardEntry must be passed a new MIB_IPFORWARD_ROW2 structure to initialize.

On output, the ValidLifetime and PreferredLifetime members of the MIB_IPFORWARD_ROW2 structure pointed to by Row parameter will be initialized to infinite and the Loopback, AutoconfigureAddress, Publish, and Immortal members will be initialized to TRUE. In addition, the SitePrefixLength, Metric, and Protocol members are set to an illegal value and other fields are initialized to zero.

After calling InitializeIpForwardEntry, an application can then change the members in the MIB_IPFORWARD_ROW2 entry it wishes to modify, and then call the CreateIpForwardEntry2 to add the new IP route entry to the local computer.

-see-also

CreateIpForwardEntry2

DeleteIpForwardEntry2

GetBestRoute2

GetIpForwardEntry2

GetIpForwardTable2

MIB_IPFORWARD_ROW2

MIB_IPFORWARD_TABLE2

NotifyRouteChange2

SetIpForwardEntry2