Fonction RtmRegisterForChangeNotification (rtmv2.h)

Article
08/25/2023

La fonction RtmRegisterForChangeNotification informe le gestionnaire de tables de routage que le client doit recevoir des notifications de modification pour les types de modifications spécifiés. Le gestionnaire de table de routage retourne un handle de notification de modification, que le client doit utiliser lors de la demande d’informations de modification après la réception d’un message de notification de modification.

Syntaxe

DWORD RtmRegisterForChangeNotification(
  [in]  RTM_ENTITY_HANDLE  RtmRegHandle,
  [in]  RTM_VIEW_SET       TargetViews,
  [in]  RTM_NOTIFY_FLAGS   NotifyFlags,
  [in]  PVOID              NotifyContext,
  [out] PRTM_NOTIFY_HANDLE NotifyHandle
);

Paramètres

[in] RtmRegHandle

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

[in] TargetViews

Spécifie les vues dans lesquelles s’inscrire pour la notification de modification.

[in] NotifyFlags

Spécifie les indicateurs qui indiquent le type de modifications pour lesquelles le client demande la notification. Les indicateurs suivants sont utilisés. (Les indicateurs doivent être joints à l’aide d’un OR logique.)

Constant	Signification
RTM_CHANGE_TYPE_ALL	Informez le client de toute modification apportée à une destination.
RTM_CHANGE_TYPE_BEST	Informez le client des modifications apportées à la meilleure route actuelle, ou quand la meilleure route change.
RTM_CHANGE_TYPE_FORWARDING	Informez le client de toutes les modifications d’itinéraire qui affectent le transfert, telles que les modifications de tronçon suivant.
RTM_NOTIFY_ONLY_MARKED_DESTS	Informez le client des modifications apportées aux destinations qu’il a marquées. Si cet indicateur n’est pas spécifié, les messages de notification de modification pour toutes les destinations sont envoyés.

[in] NotifyContext

Spécifie le contexte de notification que le RTM_EVENT_CALLBACK utilise pour indiquer les nouvelles modifications. Le contexte de notification est le paramètre Context2 du rappel RTM_EVENT_CALLBACK .

[out] NotifyHandle

Reçoit un handle pour une notification de modification. Le handle doit être utilisé lors de l’appel de RtmGetChangedDests.

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_INVALID_PARAMETER	Un paramètre contient des informations incorrectes.
ERROR_NO_SYSTEM_RESOURCES	Il n’y a pas suffisamment de ressources système disponibles pour effectuer cette opération. Le gestionnaire de table de routage a dépassé le nombre maximal de notifications de modification pouvant être mises en cache.
ERROR_NOT_ENOUGH_MEMORY	La mémoire est insuffisante pour effectuer cette opération.
ERROR_NOT_SUPPORTED	Une ou plusieurs des vues spécifiées ne sont pas prises en charge.

Remarques

Un client appelle RtmMarkDestForChangeNotification lorsqu’il s’inscrit pour les modifications apportées à une destination spécifique.

Le gestionnaire de tables de routage utilise le rappel RTM_EVENT_CALLBACK , spécifié lorsque le client a appelé RtmRegisterEntity, pour avertir le client lorsque des modifications se sont produites ; le client doit appeler RtmGetChangedDests pour recevoir les informations de modification réelles.

Pour obtenir un exemple de code utilisant cette fonction, consultez Register For Change Notification.

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]
Plateforme cible	Windows
En-tête	rtmv2.h
Bibliothèque	Rtm.lib
DLL	Rtm.dll

Voir aussi

RtmDeregisterFromChangeNotification

RtmGetChangedDests

RtmMarkDestForChangeNotification

Partager via