RtmDeleteRoute fonction)

[cette api a été remplacée par l’api du gestionnaire de Table de routage Version 2 et ne sera pas disponible au-delà de Windows Server 2003. Les applications doivent utiliser l’API du gestionnaire de table de routage version 2.]

La fonction RtmDeleteRoute supprime une entrée d’itinéraire.

Syntaxe

DWORD RtmDeleteRoute(
  _In_  HANDLE ClientHandle,
  _In_  PVOID  Route,
  _Out_ DWORD  Flags,
  _Out_ PVOID  CurBestRoute
);

Paramètres

ClientHandle [ dans]

Handle qui identifie le client et, par conséquent, le protocole de routage de l’itinéraire ajouté ou mis à jour. Obtenez ce handle en appelant RtmRegisterClient.

Itinéraire [ dans]

Pointeur vers une structure spécifique à la famille de protocoles qui spécifie l’itinéraire nouveau ou mis à jour. Les champs suivants sont utilisés par le gestionnaire de tables de routage pour mettre à jour la table de routage :

Valeur Signification
Réseau de RR _
Spécifie le numéro de réseau de destination.
RR _ InterfaceId
Spécifie l’index de l’interface par le biais duquel l’itinéraire a été reçu.
_NEXTHOPADDRESS RR
Spécifie l’adresse réseau du routeur de tronçon suivant.

Indicateurs [ à]

Pointeur vers un jeu d’indicateurs qui indiquent le type du message de modification et les informations qui ont été placées dans les mémoires tampons fournies. Ce paramètre est l’une des valeurs suivantes.

Indicateurs Signification
RTM- _ aucune _ modification
La suppression de l’itinéraire n’a pas affecté le meilleur itinéraire vers un réseau de destination. En d’autres termes, une autre entrée représente un itinéraire vers le même réseau de destination et a une métrique inférieure.
_itinéraire RTM _ supprimé
L’itinéraire supprimé était le seul itinéraire disponible pour un réseau de destination particulier.
_itinéraire RTM _ modifié
Après la suppression de cet itinéraire, un autre itinéraire est devenu le meilleur itinéraire vers un réseau de destination particulier. CurBestRoute pointe vers les informations pour le nouveau meilleur itinéraire.

CurBestRoute [ à]

Pointeur vers une structure qui reçoit les informations de meilleure route actuelles, le cas échéant. Le type de la structure est spécifique à la famille de protocoles, par exemple, IP ou IPX.

Ce paramètre est facultatif. Si l’appelant spécifie la valeur null pour ce paramètre, les informations de meilleure route actuelles ne sont pas retournées.

Valeur de retour

Si la fonction est réussie, la valeur de retour n’est pas une _ erreur.

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

Valeur Description
HANDLE d’erreur _ non valide _
Le paramètre de handle du client n’est pas un handle valide.
paramètre d’erreur _ non valide _
La structure d’itinéraire vers laquelle pointe le paramètre d' itinéraire contient une valeur de membre.
ERREUR _ aucun _ itinéraire de ce type _
Il n’existe aucune entrée dans la table de routage qui correspond aux paramètres de l’itinéraire spécifié.
ERREUR _ aucune _ _ ressource système
Les ressources sont insuffisantes pour effectuer l’opération.

Remarques

La fonction génère un message de modification d’itinéraire si le meilleur itinéraire vers un réseau de destination a été modifié à la suite de la suppression. Toutefois, le message de modification d’itinéraire n’est pas envoyé au client qui effectue cet appel. Au lieu de cela, les informations pertinentes sont retournées par cette fonction directement à ce client.

Configuration requise

Condition requise Valeur
Client minimal pris en charge
Aucun pris en charge
Serveur minimal pris en charge
Windows 2000 Server - [Applications de bureau uniquement]
Fin de la prise en charge des serveurs
Windows Server 2003
En-tête
RTM. h
Bibliothèque
RTM. lib
DLL
Rtm.dll

Voir aussi

Référence de la version 1 du gestionnaire de tables de routage

Fonctions de la version 1 du gestionnaire de table de routage

RtmAddRoute

RtmDequeueRouteChangeMessage