Fonction RtmGetExactMatchRoute (rtmv2.h)

Article
08/25/2023

La fonction RtmGetExactMatchRoute recherche dans la table de routage un itinéraire qui correspond exactement à l’itinéraire spécifié. L’itinéraire à rechercher est indiqué par une adresse réseau, un masque de sous-réseau et d’autres critères de correspondance de routage. Si une correspondance exacte est trouvée, les informations d’itinéraire sont retournées.

Syntaxe

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
);

Paramètres

[in] RtmRegHandle

Gérez le client obtenu à partir d’un appel précédent à RtmRegisterEntity.

[in] DestAddress

Pointeur vers l’adresse réseau de destination.

[in] MatchingFlags

Spécifie les critères à utiliser lors de la recherche de l’itinéraire. Les indicateurs suivants sont utilisés.

Constant	Signification
RTM_MATCH_FULL	Mettre en correspondance les itinéraires avec tous les critères.
RTM_MATCH_INTERFACE	Mettre en correspondance les itinéraires qui se trouvent sur la même interface.
RTM_MATCH_NEIGHBOUR	Mettre en correspondance les itinéraires avec le même voisin.
RTM_MATCH_NEXTHOP	Mettre en correspondance les itinéraires qui ont le même tronçon suivant.
RTM_MATCH_NONE	Ne correspondent à aucun des critères ; tous les itinéraires pour la destination sont retournés.
RTM_MATCH_OWNER	Mettre en correspondance les itinéraires avec le même propriétaire.
RTM_MATCH_PREF	Mettre en correspondance les itinéraires qui ont la même préférence.

[in, out] RouteInfo

Lors de l’entrée, RouteInfo est un pointeur RTM_ROUTE_INFO structure qui contient les critères qui spécifient l’itinéraire à rechercher.

Lors de la sortie, RouteInfo reçoit les informations d’itinéraire pour l’itinéraire qui correspond aux critères.

[in] InterfaceIndex

Si RTM_MATCH_INTERFACE est spécifié dans MatchingFlags, InterfaceIndex spécifie l’interface sur laquelle l’itinéraire doit être présent (autrement dit, l’itinéraire a un tronçon suivant sur cette interface).

[in] TargetViews

Spécifie les vues à partir desquelles retourner des informations. Si le client spécifie RTM_VIEW_MASK_ANY, les informations de destination sont retournées à partir de toutes les vues ; toutefois, aucune information spécifique à l’affichage n’est retournée.

[out] RouteHandle

Si un handle doit être retourné : Lors de l’entrée, RouteHandle est un pointeur vers NULL.

Lors de la sortie, RouteHandle reçoit un pointeur vers le handle d’itinéraire ; dans le cas contraire, RouteHandle reste inchangé.

Si un handle n’a pas besoin d’être retourné : En entrée, RouteHandle a la valeur NULL.

Valeur retournée

Si la fonction réussit, la valeur de retour est NO_ERROR.

Si la fonction échoue, la valeur de retour est l’un des codes d’erreur suivants.

Valeur	Signification
ERROR_NOT_FOUND	L’itinéraire spécifié est introuvable.

Notes

Envisagez d’utiliser RtmGetExactMatchDestination si vous n’avez aucun critère de correspondance d’itinéraire spécifié dans le paramètre MatchingFlags .

Les membres suivants de la structure RTM_ROUTE_INFO passées dans le paramètre RouteInfo sont utilisés pour faire correspondre un itinéraire :

Voisin
NextHopsList
PrefInfo
RouteOwner

Spécifications


Client minimal pris en charge	Aucun pris en charge
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	rtmv2.h
Bibliothèque	Rtm.lib
DLL	Rtm.dll