PGET_EVENT_MESSAGE Rückruffunktion (routprot.h)

Artikel
08/25/2023

Die GetEventMessage-Funktion ruft einen Eintrag aus der Nachrichtenwarteschlange des Routingprotokolls ab. Das Routingprotokoll verwendet die Warteschlange, um den Router-Manager über asynchrone Ereignisse zu informieren.

Syntax

PGET_EVENT_MESSAGE PgetEventMessage;

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

Parameter

[out] Event

Zeiger auf ein Ereignis. Informationen zu diesem Ereignis werden in der zugeordneten Nachricht gemeldet. Beachten Sie, dass dies kein Ereignisobjekt ist. (Der ROUTING_PROTOCOL_EVENTS Typs wird in Routprot.h deklariert.)

Dieser Parameter empfängt einen der folgenden Werte:

Wert	Bedeutung
ROUTER_STOPPED	Das Routerprotokoll wurde erfolgreich heruntergefahren. Die Nachricht ist für dieses Ereignis leer. (Siehe StopProtocol)
SAVE_GLOBAL_CONFIG_INFO	Das Routingprotokoll meldet, dass seine globalen Konfigurationsinformationen von einem externen Agent geändert wurden, d. h. über andere Mittel als SetGlobalInfo. Das Routingprotokoll fordert den Router-Manager auf, diese Informationen abzurufen und dauerhaft zu speichern. Die Nachricht ist für dieses Ereignis leer.
SAVE_INTERFACE_CONFIG_INFO	Das Routingprotokoll meldet, dass die Konfigurationsinformationen, die einer ihrer Schnittstellen zugeordnet sind, von einem externen Agent geändert wurden, d. h. über andere Mittel als SetInterfaceInfo. Das Routingprotokoll fordert den Router-Manager auf, diese Informationen abzurufen und dauerhaft zu speichern. Die Nachricht enthält die ID der Schnittstelle.
UPDATE_COMPLETE	Das Routingprotokoll hat eine automatische Aktualisierungsanforderung vom Router-Manager abgeschlossen. Der Router-Manager konvertiert empfangene Routinginformationen in statische. Die Nachricht enthält den Index der Schnittstelle, für die die Aktualisierung ausgeführt wurde, den Typ der empfangenen Informationen (Routen oder Dienste) und das Ergebnisfeld, das angibt, ob die Aktualisierung erfolgreich war. Siehe DoUpdateRoutes und DoUpdateServices.

[out] Result

Zeiger auf eine MESSAGE-Union . Der Inhalt der Nachricht ist spezifisch für das gemeldete Ereignis.

Dieser Parameter ist optional. der Aufrufer kann NULL für diesen Parameter angeben.

Rückgabewert

Wenn der Eintrag erfolgreich abgerufen wurde, wird der Rückgabewert NO_ERROR.

Wenn die Nachrichtenwarteschlange des Routingprotokolls keine Einträge enthält, wird der Rückgabewert ERROR_NO_MORE_ITEMS.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Nicht unterstützt
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	routprot.h