Skip to content

Latest commit

 

History

History
153 lines (115 loc) · 4.69 KB

nf-iphlpapi-flushipnettable.md

File metadata and controls

153 lines (115 loc) · 4.69 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:iphlpapi.FlushIpNetTable
FlushIpNetTable function (iphlpapi.h)
The FlushIpNetTable function deletes all ARP entries for the specified interface from the ARP table on the local computer.
FlushIpNetTable
FlushIpNetTable function [IP Helper]
_iphlp_flushipnettable
iphlp.flushipnettable
iphlpapi/FlushIpNetTable
iphlp\flushipnettable.htm
IpHlp
cf4dea10-552d-4730-a452-9302ef3761ff
12/05/2018
FlushIpNetTable, FlushIpNetTable function [IP Helper], _iphlp_flushipnettable, iphlp.flushipnettable, iphlpapi/FlushIpNetTable
iphlpapi.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Iphlpapi.lib
Iphlpapi.dll
Windows
19H1
FlushIpNetTable
iphlpapi/FlushIpNetTable
c++
APIRef
kbSyntax
DllExport
Iphlpapi.dll
FlushIpNetTable

FlushIpNetTable function

-description

The FlushIpNetTable function deletes all ARP entries for the specified interface from the ARP table on the local computer.

-parameters

-param dwIfIndex [in]

The index of the interface for which to delete all ARP entries.

-returns

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
ERROR_ACCESS_DENIED
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).
ERROR_INVALID_PARAMETER
An input parameter is invalid, no action was taken. This error is returned if the dwIfIndex parameter is invalid.
ERROR_NOT_SUPPORTED
The IPv4 transport is not configured on the local computer.
Other
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 FlushIpNetTable function can only be called by a user logged on as a member of the Administrators group. If FlushIpNetTable 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. This 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 on Windows Vista and later 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.

Note  This function executes a privileged operation. For this function to execute successfully, the caller must be logged on as a member of the Administrators group or the NetworkConfigurationOperators group.
 

-see-also

CreateIpNetEntry

DeleteIpNetEntry

GetIfTable

GetIpNetTable

IP Helper Function Reference

IP Helper Start Page