SetUnicastIpAddressEntry function

The SetUnicastIpAddressEntry function sets the properties of an existing unicast IP address entry on a local computer.

Syntax


NETIOAPI_API SetUnicastIpAddressEntry(
  _In_  const MIB_UNICASTIPADDRESS_ROW *Row
);

Parameters

Row [in]

A pointer to a MIB_UNICASTIPADDRESS_ROW structure entry for an existing unicast IP address entry.

Return value

SetUnicastIpAddressEntry returns STATUS_SUCCESS if the function succeeds.

If the function fails, SetUnicastIpAddressEntry returns one of the following error codes:

Return codeDescription
STATUS_INVALID_PARAMETER

An invalid parameter was passed to the function. This error is returned if a NULL pointer is passed in the Row parameter, the Address member of the MIB_UNICASTIPADDRESS_ROW structure that the Row parameter points to was not set to a valid unicast IPv4 or IPv6 address, or both InterfaceLuid and InterfaceIndex members of the MIB_UNICASTIPADDRESS_ROW structure were unspecified.

STATUS_NOT_FOUND

The specified interface could not be found. This error is returned if the function cannot find the network interface that is specified by the InterfaceLuid or InterfaceIndex member of the MIB_UNICASTIPADDRESS_ROW structure that the Row parameter points to.

STATUS_NOT_SUPPORTED

The request is not supported. This error is returned if no IPv4 stack is located on the local computer and an IPv4 address was specified in the Address member of the MIB_UNICASTIPADDRESS_ROW structure that the Row parameter points to, or if no IPv6 stack is located on the local computer and an IPv6 address was specified in the Address member.

Other

Use the FormatMessage function to obtain the message string for the returned error.

 

Remarks

The GetUnicastIpAddressEntry function is typically used to retrieve an existing MIB_UNICASTIPADDRESS_ROW structure entry to be modified. A driver can then change the members in the MIB_UNICASTIPADDRESS_ROW entry that it wants to modify, and then call the SetUnicastIpAddressEntry function.

A driver can call the InitializeUnicastIpAddressEntry function to initialize the members of a MIB_UNICASTIPADDRESS_ROW structure entry with default values before making changes. However, the driver typically saves either the InterfaceLuid or InterfaceIndex member before calling InitializeUnicastIpAddressEntry and restores one of these members after the call.

Your driver must initialize the following members of the MIB_UNICASTIPADDRESS_ROW structure that the Row parameter points to.

Address

Set to a valid unicast IPv4 or IPv6 address and family.

InterfaceLuid or InterfaceIndex

These members are used in the order that is listed earlier. So if InterfaceLuid is specified, this member is used to determine the interface. If no value was set for the InterfaceLuid member (the value of this member was set to zero), the InterfaceIndex member is next used to determine the interface.

If the OnLinkPrefixLength member of the MIB_UNICASTIPADDRESS_ROW structure that the Row parameter points to is set to 255, SetUnicastIpAddressEntry sets the unicast IP address properties so that the OnLinkPrefixLength member is equal to the length of the IP address. For a unicast IPv4 address, OnLinkPrefixLength is set to 32. For a unicast IPv6 address, OnLinkPrefixLength is set to 128. If these settings would result in the incorrect subnet mask for an IPv4 address or the incorrect link prefix for an IPv6 address, the driver should set this member to the correct value before calling SetUnicastIpAddressEntry.

SetUnicastIpAddressEntry ignores the DadState, ScopeId, and CreationTimeStamp members of the MIB_UNICASTIPADDRESS_ROW structure that the Row parameter points to. These members are set by the network stack and cannot be changed by using the SetUnicastIpAddressEntry function. The ScopeId member is automatically determined by the interface that the address was added on.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

Netioapi.h (include Netioapi.h)

IRQL

< DISPATCH_LEVEL

See also

CreateUnicastIpAddressEntry
DeleteUnicastIpAddressEntry
GetUnicastIpAddressEntry
GetUnicastIpAddressTable
InitializeUnicastIpAddressEntry
MIB_UNICASTIPADDRESS_ROW
MIB_UNICASTIPADDRESS_TABLE
NotifyUnicastIpAddressChange

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft