InitializeUnicastIpAddressEntry function (netioapi.h)

Article
10/13/2021

The InitializeUnicastIpAddressEntry function initializes a MIB_UNICASTIPADDRESS_ROW structure with default values for a unicast IP address entry on the local computer.

Syntax

IPHLPAPI_DLL_LINKAGE VOID NETIOAPI_API_ InitializeUnicastIpAddressEntry(
  [out] PMIB_UNICASTIPADDRESS_ROW Row
);

Parameters

[out] Row

On entry, a pointer to a MIB_UNICASTIPADDRESS_ROW structure entry for a unicast IP address entry. On return, the MIB_UNICASTIPADDRESS_ROW structure pointed to by this parameter is initialized with default values for a unicast IP address.

Return value

This function does not return a value.

Remarks

The InitializeUnicastIpAddressEntry function is defined on Windows Vista and later.

The InitializeUnicastIpAddressEntry function must be used to initialize the members of a MIB_UNICASTIPADDRESS_ROW structure entry with default values for a unicast IP address for later use with the CreateUnicastIpAddressEntry function.

On input, InitializeUnicastIpAddressEntry must be passed a new MIB_UNICASTIPADDRESS_ROW structure to initialize.

On output, the PrefixOrigin member of the MIB_UNICASTIPADDRESS_ROW structure pointed to by Row parameter the will be initialized to IpPrefixOriginUnchanged, the SuffixOrigin member will be initialized to IpSuffixOriginUnchanged, and the OnLinkPrefixLength member will be initialized to an illegal value. In addition, the PreferredLifetime and ValidLifetime members are set to infinite, the SkipAsSource member is set to FALSE, and other fields are initialized to zero.

After calling InitializeUnicastIpAddressEntry, an application can then change the members in the MIB_UNICASTIPADDRESS_ROW entry it wishes to modify, and then call the CreateUnicastIpAddressEntry to add the new unicast IP address to the local computer.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	netioapi.h (include Iphlpapi.h)
Library	Iphlpapi.lib
DLL	Iphlpapi.dll