Función RtmGetExactMatchRoute (rtmv2.h)

Artículo
08/25/2023

La función RtmGetExactMatchRoute busca en la tabla de enrutamiento una ruta que coincida exactamente con la ruta especificada. La ruta para buscar se indica mediante una dirección de red, una máscara de subred y otros criterios de coincidencia de rutas. Si se encuentra una coincidencia exacta, se devuelve la información de ruta.

Sintaxis

DWORD RtmGetExactMatchRoute(
  [in]      RTM_ENTITY_HANDLE RtmRegHandle,
  [in]      PRTM_NET_ADDRESS  DestAddress,
  [in]      RTM_MATCH_FLAGS   MatchingFlags,
  [in, out] PRTM_ROUTE_INFO   RouteInfo,
  [in]      ULONG             InterfaceIndex,
  [in]      RTM_VIEW_SET      TargetViews,
  [out]     PRTM_ROUTE_HANDLE RouteHandle
);

Parámetros

[in] RtmRegHandle

Identificador para el cliente obtenido de una llamada anterior a RtmRegisterEntity.

[in] DestAddress

Puntero a la dirección de red de destino.

[in] MatchingFlags

Especifica los criterios que se usarán al buscar la ruta. Se usan las marcas siguientes.

Constante	Significado
RTM_MATCH_FULL	Hacer coincidir las rutas con todos los criterios.
RTM_MATCH_INTERFACE	Coincide con las rutas que se encuentran en la misma interfaz.
RTM_MATCH_NEIGHBOUR	Coincide con las rutas con el mismo vecino.
RTM_MATCH_NEXTHOP	Coincide con las rutas que tienen el mismo próximo salto.
RTM_MATCH_NONE	No coinciden con ninguno de los criterios; se devuelven todas las rutas para el destino.
RTM_MATCH_OWNER	Coincide con las rutas con el mismo propietario.
RTM_MATCH_PREF	Coincide con las rutas que tienen la misma preferencia.

[in, out] RouteInfo

En la entrada, RouteInfo es un puntero a una estructura de RTM_ROUTE_INFO que contiene los criterios que especifica la ruta que se va a buscar.

En la salida, RouteInfo recibe la información de ruta de la ruta que coincide con los criterios.

[in] InterfaceIndex

Si RTM_MATCH_INTERFACE se especifica en MatchingFlags, InterfaceIndex especifica la interfaz en la que debe estar presente la ruta (es decir, la ruta tiene un próximo salto en esa interfaz).

[in] TargetViews

Especifica las vistas desde las que se va a devolver información. Si el cliente especifica RTM_VIEW_MASK_ANY, la información de destino se devuelve de todas las vistas; sin embargo, no se devuelve información específica de la vista.

[out] RouteHandle

Si se debe devolver un identificador: en la entrada, RouteHandle es un puntero a NULL.

En la salida, RouteHandle recibe un puntero al identificador de ruta; de lo contrario, RouteHandle permanece sin cambios.

Si no es necesario devolver un identificador: en la entrada, RouteHandle es NULL.

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.

Valor	Significado
ERROR_NOT_FOUND	No se encontró la ruta especificada.

Comentarios

Considere la posibilidad de usar RtmGetExactMatchDestination si no tiene ningún criterio de coincidencia de rutas especificado en el parámetro MatchingFlags .

Los siguientes miembros de la estructura RTM_ROUTE_INFO que se pasa en el parámetro RouteInfo se usan para hacer coincidir una ruta:

Vecino
NextHopsList
PrefInfo
RouteOwner

Requisitos


Cliente mínimo compatible	No se admite ninguno
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	rtmv2.h
Library	Rtm.lib
Archivo DLL	Rtm.dll