Función GetIpForwardEntry2

Artículo
03/08/2023

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

Sintaxis

NETIOAPI_API GetIpForwardEntry2(
  _Inout_ PMIB_IPFORWARD_ROW2 Row
);

Parámetros

Fila [in, out]
Puntero a una entrada de estructura de MIB_IPFORWARD_ROW2 para una entrada de ruta IP. Si la devolución se realiza correctamente, esta estructura se actualiza con las propiedades de la entrada de ruta IP.

Valor devuelto

GetIpForwardEntry2 devuelve STATUS_SUCCESS si la función se realiza correctamente.

Si se produce un error en la función, GetIpForwardEntry2 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 se produce una de las situaciones siguientes: Se pasa un puntero NULL en el parámetro Row . El miembro DestinationPrefix de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row no se especificó. No se especificó el miembro NextHop de la estructura MIB_IPFORWARD_ROW2. Los miembros InterfaceLuid e InterfaceIndex de la estructura MIB_IPFORWARD_ROW2 no se especificaron. El miembro PreferredLifetime de la estructura MIB_IPFORWARD_ROW2 es mayor que el miembro ValidLifetime . El miembro SitePrefixLength de la estructura MIB_IPFORWARD_ROW2 es mayor que la longitud del prefijo especificada por el miembro DestinationPrefix .
STATUS_NOT_FOUND	No se encontró la interfaz especificada. Este error se devuelve si la función no encuentra 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 .
STATUS_NOT_SUPPORTED	No se admite la solicitud. Este error se devuelve si no hay ninguna pila IPv4 ubicada en el equipo local y AF_INET se especificó en la familia de direcciones del miembro DestinationPrefix de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row , o si no se encuentra ninguna pila IPv6 en el equipo local y AF_INET6 se especificó para la familia de direcciones en el miembro DestinationPrefix .
Otros	Use la función FormatMessage para obtener la cadena de mensaje para el error devuelto.

Observaciones

La función GetIpForwardEntry2 se usa para recuperar una entrada de estructura MIB_IPFORWARD_ROW2 .

En la entrada, el controlador debe inicializar los siguientes miembros de la estructura MIB_IPFORWARD_ROW2 a la que apunta el parámetro Row .

DestinationPrefix
Establézcalo en un prefijo y familia de direcciones IPv4 o IPv6 válidos.
NextHop
Establézcalo en una dirección iPv4 o IPv6 válida y una familia.
InterfaceLuid o InterfaceIndex
Estos miembros 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 (el valor de este miembro se estableció en cero), el miembro InterfaceIndex se usa a continuación para determinar la interfaz.

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

Desplazamiento de métrica de ruta que se especifica en el miembro Métrica de la estructura MIB_IPFORWARD_ROW2 que el parámetro Row apunta a 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. Un controlador puede recuperar la métrica de interfaz llamando a la función GetIpInterfaceEntry .

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

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