Función GetIpForwardEntry2 (netioapi.h)

Artículo
03/15/2023

La función GetIpForwardEntry2 recupera información de una entrada de ruta IP en el equipo local.

Sintaxis

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetIpForwardEntry2(
  [in, out] PMIB_IPFORWARD_ROW2 Row
);

Parámetros

[in, out] Row

Puntero a una entrada de estructura MIB_IPFORWARD_ROW2 para una entrada de ruta IP. Si la devolución es correcta, esta estructura se actualizará con las propiedades de la entrada de ruta IP.

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_INVALID_PARAMETER	Se pasó un parámetro no válido a la función. Este error se devuelve si no se ha especificado un puntero NULL en el parámetro Row , no se especificó el miembro DestinationPrefix del MIB_IPFORWARD_ROW2 al que apunta el parámetro Row , no se especificó el miembro NextHop del MIB_IPFORWARD_ROW2 al que apunta el parámetro Row o los miembros InterfaceLuid o InterfaceIndex del MIB_IPFORWARD_ROW2 señalados por el parámetro Row . el parámetro no se especificó.
ERROR_NOT_FOUND	Elemento no encontrado. Este error se devuelve si la interfaz de red especificada por el miembro InterfaceLuid o InterfaceIndex de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row no coincide con el prefijo de dirección IP y la familia de direcciones especificadas en el miembro DestinationPrefix de la estructura MIB_IPFORWARD_ROW2 .
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 la familia de direcciones en el miembro DestinationPrefix del MIB_IPFORWARD_ROW2 señalado por el parámetro Row . Este error también se devuelve si no hay ninguna pila IPv6 en el equipo local y AF_INET6 se especificó para la familia de direcciones en el miembro DestinationPrefix .
Otros	Use FormatMessage para obtener la cadena de mensaje del error devuelto.

Comentarios

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

La función GetIpForwardEntry2 se usa para recuperar 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 siguientes miembros de la estructura MIB_IPFORWARD_ROW2 que apunta 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 usa a continuación para determinar la interfaz.

Cuando la llamada se realiza correctamente, GetIpForwardEntry2 recupera las demás propiedades de la entrada de ruta IP y rellena la estructura de MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row .

El desplazamiento de la métrica de ruta especificado en el miembro Métrica de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row representa solo parte de la métrica de ruta completa. La métrica completa es una combinación de esta métrica de ruta agregada a la métrica de interfaz especificada en el miembro Métrica de la estructura MIB_IPINTERFACE_ROW de la interfaz asociada. Una aplicación puede recuperar la métrica de interfaz llamando a la función GetIpInterfaceEntry .

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

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