RtmDequeueRouteChangeMessage 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 RtmDequeueRouteChangeMessage retourne le prochain message de modification de l’itinéraire dans la file d’attente associée au client spécifié.

Syntaxe

DWORD RtmDequeueRouteChangeMessage(
  _In_  HANDLE ClientHandle,
  _Out_ DWORD  Flags,
  _Out_ PVOID  CurBestRoute,
  _Out_ PVOID  PrevBestRoute
);

Paramètres

ClientHandle [ dans]

Handle qui identifie le client pour lequel l’opération est effectuée. Obtenez ce handle en appelant RtmRegisterClient.

Indicateurs [ à]

Pointeur vers une variable DWORD . La valeur de cette variable est définie par le gestionnaire de tables de routage. La valeur spécifie le type du message de modification et les informations qui ont été retournées dans les mémoires tampons fournies. Ce paramètre est l’un des éléments suivants.

Indicateurs Signification
_itinéraire RTM _ ajouté
Le premier itinéraire a été ajouté pour un réseau de destination particulier. Le paramètre CurBestRoute pointe vers les informations de l’itinéraire ajouté.
_itinéraire RTM _ supprimé
Le seul itinéraire disponible pour un réseau de destination particulier a été supprimé. Le paramètre PrevBestRoute pointe vers les informations de l’itinéraire supprimé.
_itinéraire RTM _ modifié
Au moins un des paramètres significatifs a été modifié pour un itinéraire optimal vers un réseau de destination particulier. Les paramètres significatifs sont les suivants :
Identificateur de protocole
Index d’interface
Adresse du tronçon suivant
Données spécifiques à la famille de protocoles (y compris les métriques d’itinéraires)

Le paramètre PrevBestRoute pointe vers les informations d’itinéraire telles qu’elles étaient avant la modification. Le paramètre CurBestRoute pointe vers les informations d’itinéraire actuelles (autrement dit, après modification).

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.

PrevBestRoute [ à]

Pointeur vers une structure qui reçoit les informations de meilleur itinéraire précédentes, 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 null pour ce paramètre, les informations sur le meilleur itinéraire précédent ne sont pas retournées.

Valeur de retour

La valeur de retour est l’un des codes suivants.

Valeur Description
AUCUNE _ erreur
Ce message était le dernier message de la file d’attente du client. L’objet d’événement est réinitialisé.
HANDLE d’erreur _ non valide _
Le paramètre ClientHandle n’est pas un handle valide, ou à l’inscription, le client n’a pas fourni d’objet d’événement pour la notification de modification de message (voir RtmRegisterClient).
MESSAGES d’erreur _ supplémentaires _
La file d’attente du client contient des messages supplémentaires. Le client doit appeler RtmDequeueRouteChangeMessage à nouveau dès que possible pour permettre au gestionnaire de tables de routage de libérer les ressources associées aux messages en attente.
ERREUR _ aucun _ message
La file d’attente du client ne contient aucun message. l’appel n’a pas été sollicité. L’événement est réinitialisé.
ERREUR _ aucune _ _ ressource système
Les ressources sont insuffisantes pour effectuer l’opération.

Spécifications

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

RtmRegisterClient