SetIpNetEntry2 (Compact 2013)
3/26/2014
This function sets the physical address of an existing neighbor IP address entry on the local device.
Syntax
NETIOAPI_API SetIpNetEntry2(
__inout PMIB_IPNET_ROW2 Row
);
Parameters
- Row
A pointer to a MIB_IPNET_ROW2 structure entry for a neighbor IP address entry.
Return Value
Error Code |
Meaning |
|---|---|
NO_ERROR |
The function succeeds |
ERROR_ACCESS_DENIED |
Access is denied. This error is returned under several conditions that include the following: the user lacks the required administrative rights on the local device or the application is not running in an enhanced shell as the built-in Administrator (RunAs administrator). |
ERROR_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_IPNET_ROW2 pointed to by the Row parameter was not set to a valid unicast, anycast, or multicast IPv4 or IPv6 address, the PhysicalAddress and PhysicalAddressLength members of the MIB_IPNET_ROW2 pointed to by the Row parameter were not set to a valid physical address, or both the InterfaceLuid or InterfaceIndex members of the MIB_IPNET_ROW2 pointed to by the Row parameter were unspecified. This error is also returned if a loopback address was passed in the Address member. |
ERROR_NOT_FOUND |
The specified interface could not be found. This error is returned if the network interface specified by the InterfaceLuid or InterfaceIndex member of the MIB_IPNET_ROW2 pointed to by the Row parameter could not be found. |
ERROR_NOT_SUPPORTED |
The request is not supported. This error is returned if no IPv4 stack is on the local device and an IPv4 address was specified in the Address member of the MIB_IPNET_ROW2 pointed to by the Row parameter or no IPv6 stack is on the local device and an IPv6 address was specified in the Address member. |
Other |
Use FormatMessage to obtain the message string for the returned error. |
Remarks
The SetIpNetEntry2 function is used to set the physical address for an existing neighbor IP address entry on a local device.
The Address member in the MIB_IPNET_ROW2 structure pointed to by the Row parameter must be initialized to a valid unicast, anycast, or multicast IPv4 or IPv6 address and family. The PhysicalAddress and PhysicalAddressLength members in the MIB_IPNET_ROW2 structure pointed to by the Row parameter must be initialized to a valid physical address. In addition, at least one of the following members in the MIB_IPNET_ROW2 structure pointed to the Row parameter must be initialized to the interface: the InterfaceLuid or InterfaceIndex. The fields are used in the order listed above. So if the InterfaceLuid is specified, this member is used to determine the interface on which to add the unicast IP address. If no value was set for the InterfaceLuid member (the values of this member was set to zero), the InterfaceIndex member is next used to determine the interface.
The SetIpNetEntry2 function will fail if the IP address passed in the Address member of the MIB_IPNET_ROW2 pointed to by the Row parameter is not an existing neighbor IP address on the interface specified.
The SetIpNetEntry2 function can only be called by a user logged on as a member of the Administrators group. If SetIpNetEntry2 is called by a user who is not a member of the Administrators group, the function call will fail and ERROR_ACCESS_DENIED is returned.
See Also
Reference
IP Helper Functions
CreateIpNetEntry2
DeleteIpNetEntry2
FlushIpNetTable2
GetIpNetEntry2
GetIpNetTable2
MIB_IPNET_ROW2
MIB_IPNET_TABLE2
ResolveIpNetEntry2