Función FlushIpPathTable (netioapi.h)

  • Artículo

La función FlushIpPathTable vacía la tabla de ruta de acceso IP en el equipo local.

Sintaxis

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API FlushIpPathTable(
  [in] ADDRESS_FAMILY Family
);

Parámetros

[in] Family

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 PF_ son idénticas (por ejemplo, AF_INET y PF_INET), por lo que se puede usar cualquiera de las constantes.

En el Windows SDK publicado para Windows Vista y versiones posteriores, la organización de 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
 No se especifica la familia de direcciones. Cuando se especifica este parámetro, esta función vacía la tabla de ruta de acceso IP 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 ruta de acceso IP 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 ruta de acceso IP que contiene solo entradas IPv6.

Valor devuelto

Si la función se ejecuta 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 para el error devuelto.

Comentarios

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

The
La función FlushIpPathTable vacía o elimina las entradas de ruta de acceso IP en un sistema local. El parámetro Family se puede usar 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 ruta de acceso IP para IPv4 e IPv6, establezca el parámetro Family en AF_UNSPEC.

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

Un usuario que inició sesión como miembro del grupo Administradores solo puede llamar a la función FlushIpPathTable . Si un usuario llama a FlushIpPathTable que no es miembro del grupo Administradores, se producirá un error en la llamada de 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 que ha iniciado sesión como miembro del grupo Administradores que no sea el administrador integrado ejecuta esta función, se producirá un error en esta llamada 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 distinto del 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 (include Iphlpapi.h)
Library Iphlpapi.lib
Archivo DLL Iphlpapi.dll

Consulte también

GetIpPathEntry

GetIpPathTable

MIB_IPPATH_ROW

MIB_IPPATH_TABLE