PGET_EVENT_MESSAGE fonction de rappel (routprot.h)

Article
03/01/2024

La fonction GetEventMessage obtient une entrée de la file d’attente de messages du protocole de routage. Le protocole de routage utilise la file d’attente pour informer le gestionnaire de routeur des événements asynchrones.

Syntaxe

PGET_EVENT_MESSAGE PgetEventMessage;

DWORD PgetEventMessage(
  [out] ROUTING_PROTOCOL_EVENTS *Event,
  [out] MESSAGE *Result
)
{...}

Paramètres

[out] Event

Pointeur vers un événement. Les informations relatives à cet événement sont signalées dans le message associé. Notez qu’il ne s’agit pas d’un objet d’événement. (Le type ROUTING_PROTOCOL_EVENTS est déclaré dans Routprot.h.)

Ce paramètre reçoit l’une des valeurs suivantes :

Valeur	Signification
ROUTER_STOPPED	Le protocole du routeur s’est arrêté avec succès. Le message est vide pour cet événement. (Voir StopProtocol)
SAVE_GLOBAL_CONFIG_INFO	Le protocole de routage signale que ses informations de configuration globales ont été modifiées par un agent externe, c’est-à-dire par des moyens autres que SetGlobalInfo. Le protocole de routage demande au gestionnaire de routeur de récupérer et de stocker ces informations de manière permanente. Le message est vide pour cet événement.
SAVE_INTERFACE_CONFIG_INFO	Le protocole de routage signale que les informations de configuration associées à l’une de ses interfaces ont été modifiées par un agent externe, c’est-à-dire par des moyens autres que SetInterfaceInfo. Le protocole de routage demande au gestionnaire de routeur de récupérer et de stocker ces informations de manière permanente. Le message contient l’ID de l’interface.
UPDATE_COMPLETE	Le protocole de routage a effectué une demande de mise à jour autostatique du gestionnaire de routeur. Le gestionnaire de routeur convertit les informations de routage reçues en statiques. Le message contient l’index de l’interface sur laquelle la mise à jour a été effectuée, le type des informations reçues (routes ou services) et le champ de résultat, qui indique si la mise à jour a réussi. Consultez DoUpdateRoutes et DoUpdateServices.

[out] Result

Pointeur vers une union MESSAGE . Le contenu du message est spécifique à l’événement signalé.

Ce paramètre est facultatif ; l’appelant peut spécifier NULL pour ce paramètre.

Valeur retournée

Si l’entrée est récupérée avec succès, la valeur de retour est NO_ERROR.

Si la file d’attente des messages du protocole de routage ne contient aucune entrée, la valeur de retour est ERROR_NO_MORE_ITEMS.

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	routprot.h