Función FlushIpNetTable2
La función FlushIpNetTable2 vacía la tabla de vecinos IP en un equipo local.
Sintaxis
NETIOAPI_API FlushIpNetTable2(
_In_ ADDRESS_FAMILY Family,
_In_ NET_IFINDEX InterfaceIndex
);
Parámetros
Familia [in]
Familia de direcciones que se vacia.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 de PF_ son idénticas (por ejemplo, AF_INET y PF_INET), por lo que puede usar cualquiera de las constantes.
En Windows Vista y versiones posteriores de los sistemas operativos Windows, los valores posibles para el parámetro Family se definen en el archivo de encabezado Ws2def.h. Tenga en cuenta que el archivo de encabezado Ws2def.h se incluye automáticamente en Netioapi.h y nunca debe usar Ws2def.h directamente.
Actualmente se admiten los siguientes valores para la familia de direcciones:
AF_INET
Familia de direcciones IPv4. Cuando se especifica este valor, esta función vacía la tabla de direcciones IP vecinas que contiene solo entradas IPv4.AF_INET6
Familia de direcciones IPv6. Cuando se especifica este valor, esta función vacía la tabla de direcciones IP vecinas que contiene solo entradas IPv6.AF_UNSPEC
No se especifica la familia de direcciones. Cuando se especifica este valor, esta función vacía la tabla de direcciones IP vecinas que contiene entradas IPv4 e IPv6.
InterfaceIndex [in]
Índice de interfaz. Si se especifica el índice, la función vacía las entradas de dirección IP vecinas en una interfaz específica. De lo contrario, la función vacía las entradas de dirección IP vecinas en todas las interfaces. Para pasar por alto la interfaz, establezca este parámetro en cero.
Valor devuelto
FlushIpNetTable2 devuelve STATUS_SUCCESS si la función se realiza correctamente.
Si se produce un error en la función, FlushIpNetTable2 devuelve uno de los siguientes códigos de error:
| Código devuelto | Descripción |
|---|---|
| STATUS_INVALID_PARAMETER | Se pasó un parámetro no válido a la función. Este error se devuelve si no se especificó el parámetro Family como AF_INET, AF_INET6 o AF_UNSPEC. |
| STATUS_NOT_SUPPORTED | No se admite la solicitud. Este error se devuelve si no se encuentra ninguna pila IPv4 en el equipo local y AF_INET se especificó en el parámetro Family , o si no se encuentra 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 la función FormatMessage para obtener la cadena de mensaje para el error devuelto. |
Observaciones
La función FlushIpNetTable2 vacía o elimina las direcciones IP vecinas en un equipo local. El controlador puede usar el parámetro Family para limitar las direcciones IP vecinas para eliminar a una familia de direcciones IP determinada. Si se deben eliminar direcciones IP vecinas para IPv4 e IPv6, el controlador debe establecer el parámetro Family en AF_UNSPEC. El controlador puede usar el parámetro InterfaceIndex para limitar las direcciones IP vecinas para eliminar a una interfaz determinada. Si se deben eliminar las direcciones IP vecinas de todas las interfaces, el controlador debe establecer el parámetro InterfaceIndex en cero.
El controlador debe inicializar el parámetro Family en AF_INET, AF_INET6 o AF_UNSPEC.
Requisitos
Plataforma de destino |
Universal |
Versión |
Disponible en Windows Vista y versiones posteriores de los sistemas operativos Windows. |
Encabezado |
Netioapi.h (incluya Netioapi.h) |
Biblioteca |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |