DeleteUnicastIpAddressEntry (Compact 7)
3/12/2014
This function deletes an existing unicast IP address entry on the local device.
Syntax
NETIOAPI_API DeleteUnicastIpAddressEntry(
__in const MIB_UNICASTIPADDRESS_ROW* Row
);
Parameters
- Row
A pointer to a MIB_UNICASTIPADDRESS_ROW structure entry for an existing unicast IP address entry to delete from the local device.
Return Value
| Return code | Description |
|---|---|
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 credentials on the local device or the application is not running in an improved 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_UNICASTIPADDRESS_ROW pointed to by the Row parameter was not set to a valid unicast IPv4 or IPv6 address, or both the InterfaceLuid or InterfaceIndex members of the MIB_UNICASTIPADDRESS_ROW pointed to by the Row parameter were unspecified. |
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_UNICASTIPADDRESS_ROW 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 located on the local device and an IPv4 address was specified in the Address member MIB_UNICASTIPADDRESS_ROW pointed to by the Row parameter. This error is also returned if no IPv6 stack is located 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 DeleteUnicastIpAddressEntry function is used to delete an existing MIB_UNICASTIPADDRESS_ROW structure entry on the local device.
On input, the Address member in the MIB_UNICASTIPADDRESS_ROW structure pointed to by the Row parameter must be set to a valid unicast IPv4 or IPv6 address and family. In addition, at least one of the following members in the MIB_UNICASTIPADDRESS_ROW structure pointed to the Row parameter must be initialized: the InterfaceLuid or InterfaceIndex. The fields are used in the order listed earlier. So if the InterfaceLuid is specified, this member is used to determine the interface. 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.
If the function is successful, the existing IP address represented by the Row parameter was deleted.
The GetUnicastIpAddressTable function can be called to enumerate the unicast IP address entries on a local device. The GetUnicastIpAddressEntry function can be called to retrieve a specific existing unicast IP address entry.
The DeleteUnicastIpAddressEntry function can only be called by a user who is logged on as a member of the Administrators group. If DeleteUnicastIpAddressEntry 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
CreateUnicastIpAddressEntry
GetUnicastIpAddressEntry
GetUnicastIpAddressTable
InitializeUnicastIpAddressEntry
MIB_UNICASTIPADDRESS_ROW
MIB_UNICASTIPADDRESS_TABLE
NotifyUnicastIpAddressChange
SetUnicastIpAddressEntry