DeleteIpNetEntry function (iphlpapi.h)
The DeleteIpNetEntry function deletes an ARP entry from the ARP table on the local computer.
Syntax
IPHLPAPI_DLL_LINKAGE DWORD DeleteIpNetEntry(
[in] PMIB_IPNETROW pArpEntry
);
Parameters
[in] pArpEntry
A pointer to a MIB_IPNETROW structure. The information in this structure specifies the entry to delete. The caller must specify values for at least the dwIndex and dwAddr members of this structure.
Return value
The function returns NO_ERROR (zero) if the function is successful.
If the function fails, the return value is one of the following error codes.
| Return code | Description |
|---|---|
|
Access is denied. This error is returned on Windows Vista and Windows Server 2008 under several conditions that include the following: the user lacks the required administrative privileges on the local computer or the application is not running in an enhanced shell as the built-in Administrator (RunAs administrator). |
|
An input parameter is invalid, no action was taken. This error is returned if the pArpEntry parameter is NULL or a member in the MIB_IPNETROW structure pointed to by the pArpEntry parameter is invalid. |
|
The IPv4 transport is not configured on the local computer. |
|
Use FormatMessage to obtain the message string for the returned error. |
Remarks
To retrieve the ARP table, call the GetIpNetTable function.
On Windows Vista and later, the DeleteIpNetEntry function can only be called by a user logged on as a member of the Administrators group. If DeleteIpNetEntry is called by a user that is not a member of the Administrators group, the function call will fail and ERROR_ACCESS_DENIED is returned.
The DeleteIpNetEntry function can also fail because of user account control (UAC) on Windows Vista and later. If an application that contains this function is executed by a user logged on as a member of the Administrators group other than the built-in Administrator, this call will fail unless the application has been marked in the manifest file with a requestedExecutionLevel set to requireAdministrator. If the application lacks this manifest file, a user logged on as a member of the Administrators group other than the built-in Administrator must then be executing the application in an enhanced shell as the built-in Administrator (RunAs administrator) for this function to succeed.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 2000 Professional [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Target Platform | Windows |
| Header | iphlpapi.h |
| Library | Iphlpapi.lib |
| DLL | Iphlpapi.dll |