Función FlushIpNetTable2 (netioapi.h)

Artículo
08/25/2023

La función FlushIpNetTable2 vacía la tabla de vecinos ip en el equipo local.

Sintaxis

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API FlushIpNetTable2(
  [in] ADDRESS_FAMILY Family,
  [in] NET_IFINDEX    InterfaceIndex
);

Parámetros

[in] Family

Familia de direcciones que se va a vaciar.

Los valores posibles para la familia de direcciones se enumeran en el archivo de encabezado Winsock2.h . Tenga en cuenta que los valores de la familia de direcciones AF_ y las constantes de familia de protocolos PF_ son idénticos (por ejemplo, AF_INET y PF_INET), por lo que se puede usar cualquier constante.

En el Windows SDK publicado para Windows Vista y versiones posteriores, la organización de los archivos de encabezado ha cambiado y los valores posibles para este miembro se definen en el archivo de encabezado Ws2def.h. Tenga en cuenta que el archivo de encabezado Ws2def.h se incluye automáticamente en Winsock2.h y nunca se debe usar directamente.

Los valores admitidos actualmente son AF_INET, AF_INET6 y AF_UNSPEC.

Valor	Significado
AF_UNSPEC 0	La familia de direcciones no está especificada. Cuando se especifica este parámetro, esta función vacía la tabla de direcciones IP vecinas que contiene entradas IPv4 e IPv6.
AF_INET 2	Familia de direcciones del Protocolo de Internet versión 4 (IPv4). Cuando se especifica este parámetro, esta función vacía la tabla de direcciones IP vecinas que contiene solo entradas IPv4.
AF_INET6 23	Familia de direcciones del Protocolo de Internet versión 6 (IPv6). Cuando se especifica este parámetro, esta función vacía la tabla de direcciones IP vecinas que contiene solo entradas IPv6.

[in] InterfaceIndex

Índice de interfaz. Si se especifica el índice, vacíe las entradas de dirección IP vecinas en una interfaz específica; de lo contrario, vacíe las entradas de la dirección IP vecina en todas las interfaces. Para omitir la interfaz, establezca este parámetro en cero.

Valor devuelto

Si la función se realiza correctamente, el valor devuelto es NO_ERROR.

Si se produce un error en la función, el valor devuelto es uno de los siguientes códigos de error.

Código devuelto	Descripción
ERROR_ACCESS_DENIED	Acceso denegado. Este error se devuelve en varias condiciones que incluyen lo siguiente: el usuario carece de los privilegios administrativos necesarios en el equipo local o la aplicación no se ejecuta en un shell mejorado como administrador integrado (administrador de RunAs).
ERROR_INVALID_PARAMETER	Se pasó un parámetro no válido a la función. Este error se devuelve si el parámetro Family no se especificó como AF_INET, AF_INET6 o AF_UNSPEC.
ERROR_NOT_SUPPORTED	No se admite la solicitud. Este error se devuelve si no hay ninguna pila IPv4 en el equipo local y AF_INET se especificó en el parámetro Family . Este error también se devuelve si no hay ninguna pila IPv6 en el equipo local y AF_INET6 se especificó en el parámetro Family . Este error también se devuelve en las versiones de Windows en las que no se admite esta función.
Otros	Use FormatMessage para obtener la cadena de mensaje del error devuelto.

Comentarios

La función FlushIpNetTable2 se define en Windows Vista y versiones posteriores.

The
La función FlushIpNetTable2 vacía o elimina las direcciones IP vecinas de un sistema local. El parámetro Family se puede usar para limitar las direcciones IP vecinas para eliminar a una familia de direcciones IP determinada. Si se deben eliminar las direcciones IP vecinas para IPv4 e IPv6, establezca el parámetro Familyen AF_UNSPEC. El parámetro InterfaceIndex se puede usar para limitar las direcciones IP vecinas para eliminar a una interfaz determinada. Si se deben eliminar las direcciones IP vecinas de todas las interfaces, establezca el parámetro InterfaceIndex en cero.

El parámetro Family debe inicializarse en AF_INET, AF_INET6 o AF_UNSPEC.

Un usuario que ha iniciado sesión como miembro del grupo Administradores solo puede llamar a la función FlushIpNetTable2 . Si un usuario llama a FlushIpNetTable2 que no es miembro del grupo Administradores, se producirá un error en la llamada a la función y se devolverá ERROR_ACCESS_DENIED . Esta función también puede producir un error debido al control de cuentas de usuario (UAC) en Windows Vista y versiones posteriores. Si un usuario inicia sesión como miembro del grupo Administradores que no sea el administrador integrado, esta llamada producirá un error a menos que la aplicación se haya marcado en el archivo de manifiesto con un valor requestedExecutionLevel establecido en requireAdministrator. Si la aplicación carece de este archivo de manifiesto, un usuario que inició sesión como miembro del grupo Administradores que no sea el administrador integrado debe ejecutar la aplicación en un shell mejorado como administrador integrado (administrador de RunAs) para que esta función se realice correctamente.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	netioapi.h (incluya Iphlpapi.h)
Library	Iphlpapi.lib
Archivo DLL	Iphlpapi.dll