Función DeleteIpForwardEntry2 (netioapi.h)

Artículo
02/29/2024

La función DeleteIpForwardEntry2 elimina una entrada de ruta IP en el equipo local.

Sintaxis

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API DeleteIpForwardEntry2(
  [in] const MIB_IPFORWARD_ROW2 *Row
);

Parámetros

[in] Row

Puntero a una entrada de estructura de MIB_IPFORWARD_ROW2 para una entrada de ruta IP. Si la devolución se realiza correctamente, esta entrada se eliminará.

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 no se especificó un puntero NULL en el parámetro Row , no se especificó el miembro DestinationPrefix del MIB_IPFORWARD_ROW2 señalado por el parámetro Row , no se especificó el miembro NextHop del MIB_IPFORWARD_ROW2 señalado por el parámetro Row , o los miembros InterfaceLuid o InterfaceIndex del MIB_IPFORWARD_ROW2 apuntados por el parámetro Row . el parámetro no se especificó.
ERROR_NOT_FOUND	No se encontró la interfaz especificada. Este error se devuelve si no se encontró la interfaz de red especificada por el miembro InterfaceLuid o InterfaceIndex del MIB_IPFORWARD_ROW2 señalado por el parámetro Row .
ERROR_NOT_SUPPORTED	No se admite la solicitud. Este error se devuelve si no hay ninguna pila IPv4 en el equipo local y se especificó una dirección IPv4 en el miembro Address del MIB_IPFORWARD_ROW2 apuntado por el parámetro Row . Este error también se devuelve si no hay ninguna pila IPv6 en el equipo local y se especificó una dirección IPv6 en el miembro Address .
Otros	Use FormatMessage para obtener la cadena de mensaje para el error devuelto.

Comentarios

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

La función DeleteIpForwardEntry2 se usa para eliminar una entrada de estructura MIB_IPFORWARD_ROW2 .

En la entrada, el miembro DestinationPrefix de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row debe inicializarse en un prefijo y familia de direcciones IPv4 o IPv6 válidos. En la entrada, el miembro NextHop de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row debe inicializarse en una dirección y familia IPv4 o IPv6 válidas. Además, se debe inicializar al menos uno de los miembros siguientes de la estructura MIB_IPFORWARD_ROW2 al parámetro Row : InterfaceLuid o InterfaceIndex.

Los campos se usan en el orden indicado anteriormente. Por lo tanto, si se especifica InterfaceLuid , este miembro se usa para determinar la interfaz. Si no se estableció ningún valor para el miembro InterfaceLuid (los valores de este miembro se establecieron en cero), el miembro InterfaceIndex se usará a continuación para determinar la interfaz.

Cuando la llamada se realiza correctamente, DeleteIpForwardEntry2 elimina la entrada de ruta IP.

Se producirá un error en la función DeleteIpForwardEntry2 si los miembros DestinationPrefix y NextHop del MIB_IPFORWARD_ROW2 señalados por el parámetro Row no coinciden con una entrada de ruta IP existente en la interfaz especificada en los miembros InterfaceLuid o InterfaceIndex .

Se puede llamar a la función GetIpForwardTable2 para enumerar las entradas de ruta IP en un equipo local.

Un usuario que inició sesión como miembro del grupo Administradores solo puede llamar a la función DeleteIpForwardEntry2 . Si un usuario llama a DeleteIpForwardEntry2 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