Share via

FlushIpNetTable2 (Compact 2013)

  • Article

3/26/2014

This function flushes the IP neighbor table on the local device.

Syntax

NETIOAPI_API FlushIpNetTable2(
  __in  ADDRESS_FAMILY  Family,
  __in  NET_IFINDEX InterfaceIndex
);

Parameters

  • Family
    The address family to flush.

    Possible values for the address family are listed in the Winsock2.h header file. Realize that the values for the AF_ address family and PF_ protocol family constants are identical (for example, AF_INET and PF_INET). Therefore, either constant can be used.

    The header file organization has changed and possible values for this member are defined in the Ws2def.h header file. Be aware that the Ws2def.h header file is automatically included in Winsock2.h, and should never be used directly.

    The values currently supported are AF_INET, AF_INET6, and AF_UNSPEC:

    Value

    Meaning

    AF_UNSPEC

    0

    The address family is unspecified. When this parameter is specified, this function flushes the neighbor IP address table that contains both IPv4 and IPv6 entries.

    AF_INET

    2

    The IPv4 address family. When this parameter is specified, this function flushes the neighbor IP address table that contains only IPv4 entries.

    AF_INET6

    23

    The IPv6 address family. When this parameter is specified, this function flushes the neighbor IP address table that contains only IPv6 entries.
  • InterfaceIndex
    The interface index. If the index is specified, flush the neighbor IP address entries on a specific interface. Otherwise, flush the neighbor IP address entries on all the interfaces. To ignore the interface, set this parameter to zero.

Return Value

Return code

Description

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 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 the Family parameter was not specified as AF_INET, AF_INET6, or AF_UNSPEC.

ERROR_NOT_SUPPORTED

The request is not supported. This error is returned if no IPv4 stack is located on the local device and AF_INET was specified in the Family parameter. This error is also returned if no IPv6 stack is located on the local device and AF_INET6 was specified in the Family parameter. This error is also returned on versions of Windows where this function is not supported.

Other

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

Remarks

The FlushIpNetTable2 function flushes or deletes the neighbor IP addresses on a local system. The Family parameter can be used to limit neighbor IP addresses to delete to a particular IP address family. If neighbor IP addresses for both IPv4 and IPv6 should be deleted, set the Family parameter to AF_UNSPEC. The InterfaceIndex parameter can be used to limit neighbor IP addresses to delete to a particular interface. If neighbor IP addresses for all interfaces should be deleted, set the InterfaceIndex parameter to zero.

The Family parameter must be initialized to either AF_INET, AF_INET6, or AF_UNSPEC.

The FlushIpNetTable2 function can be called by a user logged on as a member of the Administrators group only. If FlushIpNetTable2 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
GetIpNetEntry2
GetIpNetTable2
MIB_IPNET_ROW2
MIB_IPNET_TABLE2
ResolveIpNetEntry2
SetIpNetEntry2