Función FlushIpPathTable
La función FlushIpPathTable vacía la tabla de ruta de acceso IP en un equipo local.
Sintaxis
NETIOAPI_API FlushIpPathTable(
_In_ ADDRESS_FAMILY Family
);
Parámetros
Familia [in]
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 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 ruta de acceso IP que contiene solo entradas IPv4.AF_INET6
Familia de direcciones IPv6. Cuando se especifica este valor, esta función vacía la tabla de ruta de acceso IP que contiene solo entradas IPv6.AF_UNSPEC
La familia de direcciones no está especificada. Cuando se especifica este valor, esta función vacía la tabla de direcciones IP vecinas que contiene entradas IPv4 e IPv6.
Valor devuelto
FlushIpPathTable devuelve STATUS_SUCCESS si la función se realiza correctamente.
Si se produce un error en la función, FlushIpPathTable 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 el parámetro Family no se especificó 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 del error devuelto. |
Observaciones
La función FlushIpPathTable vacía o elimina las entradas de la ruta de acceso IP de un equipo local. El controlador puede usar el parámetro Family para limitar las entradas de la ruta de acceso IP que se van a eliminar en una familia de direcciones IP determinada. Si se deben eliminar las entradas de la ruta de acceso IP para IPv4 e IPv6, el controlador debe establecer el parámetro Family en AF_UNSPEC.
El controlador debe inicializar el parámetro Family para 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 |