FlushIpPathTable function

The FlushIpPathTable function flushes the IP path table on a local computer.

Syntax


NETIOAPI_API FlushIpPathTable(
  _In_  ADDRESS_FAMILY Family
);

Parameters

Family [in]

The address family to flush.

Possible values for the address family are listed in the Winsock2.h header file. Note that the values for the AF_ address family and PF_ protocol family constants are identical (for example, AF_INET and PF_INET), so you can use either constant.

On Windows Vista and later versions of the Windows operating systems, possible values for the Family parameter are defined in the Ws2def.h header file. Note that the Ws2def.h header file is automatically included in Netioapi.h and you should never use Ws2def.h directly.

The following values are currently supported for the address family:

AF_INET

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

AF_INET6

The IPv6 address family. When this value is specified, this function flushes the IP path table that contains only IPv6 entries.

AF_UNSPEC

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

Return value

FlushIpPathTable returns STATUS_SUCCESS if the function succeeds.

If the function fails, FlushIpPathTable returns one of the following error codes:

Return codeDescription
STATUS_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.

STATUS_NOT_SUPPORTED

The request is not supported. This error is returned if no IPv4 stack is located on the local computer and AF_INET was specified in the Family parameter, or if no IPv6 stack is located on the local computer 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 the FormatMessage function to obtain the message string for the returned error.

 

Remarks

The FlushIpPathTable function flushes or deletes the IP path entries on a local computer. Your driver can use the Family parameter to limit the IP path entries to delete to a particular IP address family. If IP path entries for both IPv4 and IPv6 should be deleted, your driver should set the Family parameter to AF_UNSPEC.

Your driver must initialize the Family parameter to either AF_INET, AF_INET6, or AF_UNSPEC.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

Netioapi.h (include Netioapi.h)

IRQL

< DISPATCH_LEVEL

See also

GetIpPathEntry
GetIpPathTable
MIB_IPPATH_ROW
MIB_IPPATH_TABLE

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.